ISpellChecker::Suggest method

Retrieves spelling suggestions for the supplied text.

Syntax

HRESULT Suggest(
  LPCWSTR     word,
  IEnumString **value
);

Parameters

word

The word or phrase to get suggestions for.

value

The list of suggestions, returned as an IEnumString object.

Return value

This method can return one of these values.

Return code Description
S_OK
Successful.
S_FALSE
word is correctly spelled. value contains one entry, which is the text that was passed in.
E_ INVALIDARG
word is an empty string.
E_POINTER
word is a null pointer.

Requirements

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

See also

IEnumString

ISpellChecker