Windows Dev Center

ISpellCheckProvider::GetOptionDescription method

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

Syntax


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

Parameters

optionId [in]

Identifier of the option to be retrieved.

value [out, retval]

IOptionDescription interface that contains the information about optionId.

Return value

This method can return one of these values.

Return codeDescription
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.

 

Requirements

Minimum supported client

Windows 8 [desktop apps | Windows Store apps]

Minimum supported server

Windows Server 2012 [desktop apps | Windows Store apps]

Header

Spellcheckprovider.h

IDL

Spellcheckprovider.idl

See also

ISpellCheckProvider
IOptionDescription

 

 

Community Additions

ADD
Show:
© 2015 Microsoft