Edit

Share via

ISpellCheckProvider::SetOptionValue method (spellcheckprovider.h)

  • Article

Sets the value associated with the given option.

Syntax

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

Parameters

[in] optionId

The option identifier.

[in] value

The value to associate with optionId.

Return value

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.

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

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 spellcheckprovider.h

See also

ISpellCheckProvider