The topic you requested is included in another documentation set. For convenience, it's displayed below. Choose Switch to see the topic in its original location.

ISpellChecker::ComprehensiveCheck method

Checks the spelling of the supplied text in a more thorough manner than ISpellChecker::Check, and returns a collection of spelling errors.

Syntax

C++


HRESULT ComprehensiveCheck(
  [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 code	Description
S_OK	Successful.
E_ INVALIDARG	text is an empty string.
E_POINTER	text is a null pointer.

Remarks

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

If the provider supports two "modes" of spell checking (a faster one and a slower but more thorough one), it implements IComprehensiveSpellCheckProvider to support the more thorough checking mode. When a client calls ISpellChecker::ComprehensiveCheck, the spell checking functionality will QueryInterface the provider for IComprehensiveSpellCheckProvider, and call IComprehensiveSpellCheckProvider.ComprehensiveCheck if the interface is supported. If the interface isn't supported, it will silently fall back to ISpellCheckProvider::Check.

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