IInkRecognizerContext::IsStringSupported method (msinkaut.h)

Article
02/22/2024

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

Syntax

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

Parameters

[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
S_OK	One of the dictionaries contains the string.
E_POINTER	A parameter contained an invalid pointer.
E_INVALIDARG	Invalid input string.
E_INK_EXCEPTION	An exception occurred while processing.
E_OUTOFMEMORY	Cannot allocate memory operation.
E_UNEXPECTED	Unexpected parameter or property type.

Remarks

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.

Requirements

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