ISpellChecker::GetOptionDescription method (spellcheck.h)

Retrieves the information (id, description, heading and labels) of a specific option.

Syntax

HRESULT GetOptionDescription(
  [in]          LPCWSTR            optionId,
  [out, retval] IOptionDescription **value
);

[in] optionId

Identifier of the option to be retrieved.

[out, retval] value

IOptionDescription interface that contains the information about optionId.

This method can return one of these values.

Return code	Description
S_OK	Successful.
E_ INVALIDARG	optionId is an empty string, or it is not one of the available options.
E_POINTER	optionId is a null pointer.

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