ISpellCheckProvider::Check method

Checks the spelling of the supplied text and returns a collection of spelling errors.

Syntax


HRESULT Check(
  [in]           LPCWSTR text,
  [out, retval]  IEnumSpellingError **value
);

Parameters

text [in]

The text to check.

value [out, retval]

The result of checking this text, returned as an IEnumSpellingError object.

Return value

This method can return one of these values.

Return codeDescription
S_OK

Successful.

E_ INVALIDARG

text is an empty string.

E_POINTER

text is a null pointer.

 

Remarks

The returned IEnumSpellingError should contain the results of spell checking. A correct text should return an empty (not a null) enumeration.

Requirements

Minimum supported client

Windows 8 [desktop apps | Windows Store apps]

Minimum supported server

Windows Server 2012 [desktop apps | Windows Store apps]

Header

Spellcheckprovider.h

IDL

Spellcheckprovider.idl

See also

ISpellCheckProvider
IEnumSpellingError

 

 

Community Additions

ADD
Show:
© 2014 Microsoft