IInkWordList::RemoveWord method (msinkaut.h)

Article
02/22/2024

Removes a single word from an InkWordList.

Syntax

HRESULT RemoveWord(
  [in] BSTR RemoveWord
);

Parameters

[in] RemoveWord

The word to remove from the InkWordList.

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.
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". Therefore, removing "hello" also implicitly removes "Hello" and "HELLO". However, if you add "hello" and then try to remove "Hello", the RemoveWord call has no effect, because "Hello" was never explicitly added.

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