nf-msctf-itfreadonlyproperty-getvalue.md

UID	title	description	helpviewer_keywords	old-location	tech.root	ms.assetid	ms.date	ms.keywords	req.header	req.include-header	req.target-type	req.target-min-winverclnt	req.target-min-winversvr	req.kmdf-ver	req.umdf-ver	req.ddi-compliance	req.unicode-ansi	req.idl	req.max-support	req.namespace	req.assembly	req.type-library	req.lib	req.dll	req.irql	targetos	req.typenames	req.redist	ms.custom	f1_keywords	dev_langs	topic_type	api_type	api_location	api_name
NF:msctf.ITfReadOnlyProperty.GetValue	ITfReadOnlyProperty::GetValue (msctf.h)	ITfReadOnlyProperty::GetValue method	GetValue GetValue method [Text Services Framework] GetValue method [Text Services Framework] ITfReadOnlyProperty interface ITfReadOnlyProperty interface [Text Services Framework] GetValue method ITfReadOnlyProperty.GetValue ITfReadOnlyProperty::GetValue _tsf_itfreadonlyproperty_getvalue_ref msctf/ITfReadOnlyProperty::GetValue tsf.itfreadonlyproperty_getvalue	tsf\itfreadonlyproperty_getvalue.htm	TSF	c82ef360-e0b1-4e1a-b839-36b8e9c52347	12/05/2018	GetValue, GetValue method [Text Services Framework], GetValue method [Text Services Framework],ITfReadOnlyProperty interface, ITfReadOnlyProperty interface [Text Services Framework],GetValue method, ITfReadOnlyProperty.GetValue, ITfReadOnlyProperty::GetValue, _tsf_itfreadonlyproperty_getvalue_ref, msctf/ITfReadOnlyProperty::GetValue, tsf.itfreadonlyproperty_getvalue	msctf.h		Windows	Windows 2000 Professional [desktop apps \| UWP apps]	Windows 2000 Server [desktop apps \| UWP apps]					Msctf.idl						Msctf.dll		Windows		TSF 1.0 on Windows 2000 Professional	19H1	ITfReadOnlyProperty::GetValue msctf/ITfReadOnlyProperty::GetValue	c++	APIRef kbSyntax	COM	msctf.dll	ITfReadOnlyProperty.GetValue

ITfReadOnlyProperty::GetValue

-description

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

-parameters

-param ec [in]

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

-param pRange [in]

Pointer to an ITfRange interface that specifies the range to obtain the property for.

-param pvarValue [out]

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.

-returns

This method can return one of these values.

Value	Description
S_OK	The method was successful.
S_FALSE	The range is not covered by the property or the range contains more than one property value. pvarValue receives a VT_EMPTY value.
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-only or read/write lock.

-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-->|             |<-

-see-also

ITfDocumentMgr::CreateContext

ITfEditSession::DoEditSession

ITfRange

ITfReadOnlyProperty