ITfReadOnlyProperty::GetValue メソッド (msctf.h)

  • [アーティクル]

テキストの範囲の プロパティの値を取得します。

構文

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

パラメーター

[in] ec

編集コンテキストを識別する編集 Cookie が含まれています。 これは、 ITfDocumentMgr::CreateContext または ITfEditSession::D oEditSession から取得されます。

[in] pRange

プロパティを取得する範囲を指定する ITfRange インターフェイスへのポインター。

[out] pvarValue

プロパティ値を受け取る VARIANT 値へのポインター。 この値のデータ型と内容はプロパティ所有者によって定義され、この値を使用するには呼び出し元によって認識される必要があります。 呼び出し元は、この値を VariantClear API に渡すことで、不要になったときにこのデータを解放する必要があります。

戻り値

このメソッドは、これらの値のいずれかを返すことができます。

値 説明
S_OK
 メソッドは正常に実行されました。
S_FALSE
 範囲が プロパティでカバーされていないか、範囲に複数のプロパティ値が含まれています。 pvarValue は、VT_EMPTY値を受け取ります。
E_INVALIDARG
 1 つ以上のパラメーターが無効です。
E_FAIL
 未指定のエラーが発生しました。
TF_E_NOLOCK
 ec によって識別される編集コンテキストには、読み取り専用または読み取り/書き込みロックがありません。

解説

プロパティに pRange に対する値がない場合、 pRange にプロパティに複数の値が含まれているか、プロパティが pRange を完全にカバーしていない場合、 pvarValue はVT_EMPTY値を受け取り、メソッドは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-->|             |<-

要件

   
サポートされている最小のクライアント Windows 2000 Professional [デスクトップ アプリ |UWP アプリ]
サポートされている最小のサーバー Windows 2000 Server [デスクトップ アプリ |UWP アプリ]
対象プラットフォーム Windows
ヘッダー msctf.h
[DLL] Msctf.dll
再頒布可能パッケージ Windows 2000 Professional の TSF 1.0

関連項目

ITfDocumentMgr::CreateContext

ITfEditSession::D oEditSession

ITfRange

ITfReadOnlyProperty