ISpellCheckProvider::SetOptionValue method

Sets the value associated with the given option.

Syntax


HRESULT SetOptionValue(
  [in]  LPCWSTR optionId,
  [in]  BYTE value
);

Parameters

optionId [in]

The option identifier.

value [in]

The value to associate with 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.

 

Remarks

This method is called by the system, which reads the option values that were set by the user in the control panel and sends them to the ISpellCheckProvider. If the option was not set, this method will not be called and the provider should initialize itself internally with the default value for the option.

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

 

 

Community Additions

ADD
Show:
© 2014 Microsoft