ITfReadOnlyProperty::GetValue method (msctf.h)

Obtains the value of the property for a range of text.

Syntax

HRESULT GetValue(
  [in]  TfEditCookie ec,
  [in]  ITfRange     *pRange,
  [out] 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 specifies the range to obtain the property for.

[out] pvarValue

Pointer to a VARIANT value that receives the property value. The data type and contents of this value is defined by the property owner and must be recognized by the caller in order to use this value. The caller must release this data, when it is no longer required, by passing this value to the VariantClear API.

Return value

This method can return one of these values.

Remarks

If the property has no value over pRange, pRange contains more than one value for the property or the property does not completely cover pRange, pvarValue receives a VT_EMPTY value and the method returns S_FALSE.

COLOR:      RR      GGGGGGGG
TEXT:  this is some colored text
    range-->||<-

COLOR:      RR      GGGGGGGG
TEXT:  this is some colored text
    range-->|    |<-

COLOR:      RR      GGGGGGGG
TEXT:  this is some colored text
    range-->|             |<-

Requirements

See also

ITfDocumentMgr::CreateContext

ITfEditSession::DoEditSession

ITfRange

ITfReadOnlyProperty