ITfProperty::SetValueStore method (msctf.h)

Article
02/22/2024

Sets the value of the property for a range of text using a property store object.

Syntax

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

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 fails if pRange is empty.

[in] pPropStore

Pointer to an ITfPropertyStore interface that obtains the property data.

Return value

This method can return one of these values.

Value	Description
S_OK	The method was successful.
E_INVALIDARG	One or more parameters are invalid.
E_FAIL	An unspecified error occurred.
TF_E_NOLOCK	The edit context identified by ec does not have a read/write lock.

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

Requirement	Value
Minimum supported client	Windows 2000 Professional [desktop apps \| UWP apps]
Minimum supported server	Windows 2000 Server [desktop apps \| UWP apps]
Target Platform	Windows
Header	msctf.h
DLL	Msctf.dll
Redistributable	TSF 1.0 on Windows 2000 Professional