IComprehensiveSpellCheckProvider::ComprehensiveCheck method
Spell-check the provider text in a more thorough manner than ISpellCheckProvider::Check.
Syntax
HRESULT ComprehensiveCheck(
[in] PCWSTR text,
[out] IEnumSpellingError **result
);
Parameters
-
text [in]
-
The text to check.
-
result [out]
-
The result of checking this text, as an enumeration of spelling errors (IEnumSpellingError), if any.
Return value
This method can return one of these values.
| Return value | Description |
|---|---|
|
Successful. |
|
text is an empty string. |
|
text is a null pointer. |
Remarks
This interface isn't required to be implemented by a spell check provider. But if the provider supports two "modes" of spell checking (a faster one and a slower but more thorough one), it should implement this interface in the same object that implements ISpellCheckProvider 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.
See also