Edit

Share via

ISpellCheckProvider::InitializeWordlist method (spellcheckprovider.h)

Initialize the specified word list to contain only the specified words.

Syntax

HRESULT InitializeWordlist(
  [in] WORDLIST_TYPE wordlistType,
  [in] IEnumString   *words
);

Parameters

[in] wordlistType

The type of word list.

[in] words

The set of words to be included in the word list, passed as an IEnumString object..

Return value

This method can return one of these values.

Return code Description
S_OK
 Successful.
E_ INVALIDARG
 wordlistType is not a valid member of the WORDLIST_TYPE enumeration.

Remarks

This method is called by the system (for example, when the client calls ISpellChecker::Add), which passes the words from the respective word list to the provider so that it can consider the word list when spell checking.

Requirements

Requirement Value
Minimum supported client Windows 8 [desktop apps | UWP apps]
Minimum supported server Windows Server 2012 [desktop apps | UWP apps]
Target Platform Windows
Header spellcheckprovider.h

See also

IEnumString

ISpellCheckProvider

ISpellChecker::Add

WORDLIST_TYPE