IInkRecognizerContext::get_WordList method (msinkaut.h)

Article
02/22/2024

Gets or sets the word list that is used in the recognition process to improve the recognition results.

This property is read/write.

Syntax

HRESULT get_WordList(
  IInkWordList **WordList
);

Parameters

WordList

Return value

None

Remarks

Setting this property succeeds only if the Strokes property is NULL. You must set the WordList property before you attach an InkStrokes collection to the Strokes property of the InkRecognizerContext or you must set the Strokes property to NULL and then set the WordList property (and possibly reattach the InkStrokes collection).

To remove the current word list and use the user dictionary, set this property to NULL. Any subsequent modification of the InkWordList object does not modify the recognition outcome. If you want to change the word list, first set this property to NULL, modify the InkWordList, and then re-attach it to the InkRecognizerContext by assigning it to the WordList property.

Use the Factoid property to limit the search to the word list that is associated with the context. You may also need to set the RecognitionFlags property to improve the results.

Wordlist cannot be set after a factoid is set. This prevents a factoid from referring to a possibly non existent wordlist. Attempting to do so will result in an E_FAIL HRESULT value.

If a string is added to a word list, its capitalized versions are also implicitly added. For instance, adding "hello" implicitly adds "Hello" and "HELLO".

Using words longer than 256 characters will result in an E_POINTER exception when assigning the WordList property to InkRecognizerContext.

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