Note
Access to this page requires authorization. You can try signing in or changing directories.
Access to this page requires authorization. You can try changing directories.
Checks the spelling of the supplied text in a more thorough manner than ISpellChecker::Check, and returns a collection of spelling errors.
Syntax
HRESULT ComprehensiveCheck(
[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 |
|---|---|
|
Successful. |
|
text is an empty string. |
|
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
| 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 | spellcheck.h |
See also
IComprehensiveSpellCheckProvider