CheckPrefix Method of the IExternalDictionary Interface

This method is implemented on the client-side. This method determines if the dictionary contains a word with the specified prefix. It must return TRUE, if the dictionary contains at least one word with the prefix which is specified as a fuzzy string. This method is called during recognition of difficult cases, if the CheckPrefixes property of the ExternalDictionaryDescription object is set to TRUE.



HRESULT CheckPrefix(
  IFuzzyString* Prefix,


bool CheckPrefix( IFuzzyString Prefix );

Visual Basic .NET

Function CheckPrefix( Prefix As IFuzzyString ) As Boolean


[in] This parameter contains the fuzzy string.
[out, retval] This parameter is TRUE if the dictionary contains at least one word with the prefix which is specified in the Prefix parameter as a fuzzy string.

Return values

[C++ only] If this method returns a value other than S_OK, it indicates that an error occurred on the client-side.


  • The pointer to the FuzzyString object which was used as the Prefix parameter is released automatically after the end of the CheckPrefix method execution, therefore you do not need to call the Release method for this object in the CheckPrefix 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


24.03.2023 8:51:52

Usage of Cookies. In order to optimize the website functionality and improve your online experience ABBYY uses cookies. You agree to the usage of cookies when you continue using this site. Further details can be found in our Privacy Notice.