ITfProperty::SetValue method (msctf.h)

Sets the value of the property for a range.

Syntax

HRESULT SetValue(
  [in] TfEditCookie  ec,
  [in] ITfRange      *pRange,
  [in] const VARIANT *pvarValue
);

Parameters

[in] ec

Contains an edit cookie that identifies the edit context. This is obtained from ITfDocumentMgr::CreateContext or ITfEditSession::DoEditSession.

[in] pRange

Pointer to an ITfRange interface that contains the range that the property value is set for. This parameter cannot be NULL. This method will fail if pRange is empty.

[in] pvarValue

Pointer to a VARIANT structure that contains the new property value. Only values of type VT_I4, VT_UNKNOWN, VT_BSTR and VT_EMPTY are supported.

Return value

This method can return one of these values.

Remarks

Property values set with this method will be discarded when the text that the property value covers is modified. To gain custom control over a value response to text edits, use ITfProperty::SetValueStore.

Values set with this method are serialized, except for values of type VT_UNKNOWN, which are not serialized. If a property value of type VT_UNKNOWN must be serialized, use ITfProperty::SetValueStore instead.

Overlapping property values of the same type are unsupported.

Requirements

See also

ITfDocumentMgr::CreateContext

ITfEditSession::DoEditSession

ITfProperty

ITfProperty::SetValueStore

ITfRange