Note
Access to this page requires authorization. You can try signing in or changing directories.
Access to this page requires authorization. You can try changing directories.
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.
| Value | Description |
|---|---|
|
The method was successful. |
|
One or more parameters are invalid. |
|
A memory allocation failure occurred. |
|
An unspecified error occurred. |
|
The edit context identified by ec does not have a read/write lock. |
|
The edit context is read-only. |
|
The TSF manager does not own the range. |
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
| 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 |