ISpellCheckProvider::Check method (spellcheckprovider.h)

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

[in] text

The text to check.

[out, retval] value

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

Return value

This method can return one of these values.

Return code Description
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

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

IEnumSpellingError

ISpellCheckProvider