CheckWords Method of the IExternalDictionary Interface
This method is implemented on the client-side. It is called during recognition, and it receives a collection of fuzzy strings. The number of fuzzy strings in the collection may vary, depending on the recognized variants of the word. This method delivers to the recognizer information about strings in the collection which contains the dictionary words, with the help of the ExternalDictionaryResult method of the ExternalDictionaryCallback object. If the ExternalDictionaryResult method is not called for a fuzzy string, the recognizer assumes that proper words have not been found in the dictionary.
Syntax
C++
HRESULT CheckWords(
IFuzzyStrings* Request,
IExternalDictionaryCallback* Callback
);
C#
void CheckWords(
IFuzzyStrings Request,
IExternalDictionaryCallback Callback
);
Visual Basic .NET
Sub CheckWords( _ Request As IFuzzyStrings, _ Callback As IExternalDictionaryCallback _ )
Parameters
- Request
- [in] This variable refers to the FuzzyStrings object corresponding to the fuzzy strings collection.
- Callback
- [in] This variable refers to the ExternalDictionaryCallback object. The recognizer receives information about dictionary words from this object.
Return values
[C++ only] If this method returns a value other than S_OK, it indicates that an error occurred on the client-side.
Remarks
- The pointers to the FuzzyStrings and ExternalDictionaryCallback objects which were used as the Request and Callback parameters are released automatically after the end of the CheckWords method execution, therefore you do not need to call the Release method for these objects in the CheckWords method implementation.
- The client implementation of this method must assure that all exceptions thrown inside the method are caught and handled and no exceptions are propagated outside the method. Propagation of an exception outside the method may lead to unpredictable results (such as program termination).
See also
9/17/2024 3:14:41 PM