ITfReadOnlyProperty::GetValue-Methode (msctf.h)

Artikel
08/24/2023

Ruft den Wert der -Eigenschaft für einen Textbereich ab.

Syntax

HRESULT GetValue(
  [in]  TfEditCookie ec,
  [in]  ITfRange     *pRange,
  [out] VARIANT      *pvarValue
);

Parameter

[in] ec

Enthält ein Bearbeitungscooky, das den Bearbeitungskontext identifiziert. Dies wird von ITfDocumentMgr::CreateContext oder ITfEditSession::D oEditSession abgerufen.

[in] pRange

Zeiger auf eine ITfRange-Schnittstelle , die den Bereich angibt, für den die Eigenschaft abgerufen werden soll.

[out] pvarValue

Zeiger auf einen VARIANT-Wert , der den Eigenschaftswert empfängt. Der Datentyp und der Inhalt dieses Werts werden vom Eigenschaftenbesitzer definiert und müssen vom Aufrufer erkannt werden, um diesen Wert verwenden zu können. Der Aufrufer muss diese Daten freigeben, wenn sie nicht mehr benötigt werden, indem er diesen Wert an die VariantClear-API übergibt.

Rückgabewert

Diese Methode kann einen dieser Werte zurückgeben.

Wert	BESCHREIBUNG
S_OK	Die Methode war erfolgreich.
S_FALSE	Der Bereich wird nicht durch die -Eigenschaft abgedeckt, oder der Bereich enthält mehr als einen Eigenschaftswert. pvarValue erhält einen VT_EMPTY Wert.
E_INVALIDARG	Mindestens ein Parameter ist ungültig.
E_FAIL	Es ist ein unbekannter Fehler aufgetreten.
TF_E_NOLOCK	Der von ec identifizierte Bearbeitungskontext verfügt nicht über eine Schreib- oder Lese-/Schreibsperre.

Hinweise

Wenn die Eigenschaft keinen Wert gegenüber pRange aufweist, pRange mehr als einen Wert für die Eigenschaft enthält oder die Eigenschaft pRange nicht vollständig abdeckt, erhält pvarValue einen VT_EMPTY Wert und die Methode gibt S_FALSE zurück.


COLOR:      RR      GGGGGGGG
TEXT:  this is some colored text
    range--&gt;||&lt;-


COLOR:      RR      GGGGGGGG
TEXT:  this is some colored text
    range--&gt;|    |&lt;-


COLOR:      RR      GGGGGGGG
TEXT:  this is some colored text
    range--&gt;|             |&lt;-

Anforderungen


Unterstützte Mindestversion (Client)	Windows 2000 Professional [Desktop-Apps \| UWP-Apps]
Unterstützte Mindestversion (Server)	Windows 2000 Server [Desktop-Apps \| UWP-Apps]
Zielplattform	Windows
Kopfzeile	msctf.h
DLL	Msctf.dll
Verteilbare Komponente	TSF 1.0 unter Windows 2000 Professional

Weitere Informationen

ITfDocumentMgr::CreateContext

ITfEditSession::D oEditSession

ITfRange

ITfReadOnlyProperty

Freigeben über