IInkWordList::AddWord method (msinkaut.h)

Adds a single word to the InkWordList object.

Syntax

HRESULT AddWord(
  [in] BSTR NewWord
);

Parameters

[in] NewWord

The word to add to an InkWordList object. The word is not added if it already exists in the list.

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

Return value

This method can return one of these values.

Return code Description
S_OK
Success.
S_FALSE
The word already exists in the list.
E_OUTOFMEMORY
Cannot allocate memory to complete the operation.
E_FAIL
An unspecified error occurred.
E_POINTER
A parameter contained an invalid pointer.
E_INK_EXCEPTION
An exception occurred inside the method.

Remarks

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".

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

See also

IInkWordList

InkRecognizerContext Class

InkWordList Class

RemoveWord Method