IInkRecognizerContext::IsStringSupported method (msinkaut.h)

Indicates whether the system dictionary, user dictionary, or word list contain a specified string.


HRESULT IsStringSupported(
  [in]          BSTR         String,
  [out, retval] VARIANT_BOOL *Supported


[in] String

The string to look up in the dictionaries and word list.

For more information about the BSTR data type, see Using the COM Library.

[out, retval] Supported

When this method returns, contains VARIANT_TRUE if the string is in the dictionary or word list; otherwise VARIANT_FALSE.

Return value

This method can return one of these values.

Return code Description
One of the dictionaries contains the string.
A parameter contained an invalid pointer.
Invalid input string.
An exception occurred while processing.
Cannot allocate memory operation.
Unexpected parameter or property type.


This method considers all flags and factoid, among other things, that give context to the string that is being tested.

This method does not search the user dictionary if you specify a word list for the context. The recognizer uses the speech dictionary in Microsoft Office XP.

Use the Factoid property to limit the search to the system dictionary or the word list that is associated with the context. For example, to limit the search to the system dictionary, specify the SystemDictionary factoid. To improve the results, you may also need to set the RecognitionFlags property.


Requirement Value
Minimum supported client Windows XP Tablet PC Edition [desktop apps only]
Minimum supported server None supported
Target Platform Windows
Header msinkaut.h
Library InkObj.dll

See also

Factoid Property [InkRecognizeContext Class]


InkRecognizerContext Class

RecognitionFlags Property