ITfProperty::SetValueStore method

Syntax

HRESULT SetValueStore(
  [in] TfEditCookie     ec,
  [in] ITfRange         *pRange,
  [in] ITfPropertyStore *pPropStore
);

Parameters

ec [in]

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

pRange [in]

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

pPropStore [in]

Pointer to an ITfPropertyStore interface that obtains the property data.

Return value

This method can return one of these values.

Remarks

Property values set with ITfProperty::SetValue will be discarded when the text that the property value covers is modified. To gain control over what happens to a property value when the text is modified, use ITfProperty::SetValueStore .

Values set with ITfProperty::SetValue will be 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

ITfProperty

ITfDocumentMgr::CreateContext

ITfEditSession::DoEditSession

ITfProperty::SetValue

ITfPropertyStore

ITfRange