ISpellChecker::Suggest method

Retrieves spelling suggestions for the supplied text.

Syntax


HRESULT Suggest(
  [in]           LPCWSTR word,
  [out, retval]  IEnumString **value
);

Parameters

word [in]

The word or phrase to get suggestions for.

value [out, retval]

The list of suggestions, returned as an IEnumString object.

Return value

This method can return one of these values.

Return codeDescription
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 | Windows Store apps]

Minimum supported server

Windows Server 2012 [desktop apps | Windows Store apps]

Header

Spellcheck.h

IDL

Spellcheck.idl

See also

ISpellChecker
IEnumString

 

 

Community Additions

ADD
Show:
© 2014 Microsoft