ITfProperty::FindRange メソッド (msctf.h)

  • [アーティクル]

プロパティの空でない値を含むテキストを対象とする範囲を取得します。

構文

HRESULT FindRange(
  [in]  TfEditCookie ec,
  [in]  ITfRange     *pRange,
  [out] ITfRange     **ppRange,
  [in]  TfAnchor     aPos
);

パラメーター

[in] ec

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

[in] pRange

プロパティ範囲を取得するポイントを含む ITfRange インターフェイスへのポインター。 ポイントは、 aPos の値に基づいて、この範囲の開始アンカーまたは終了アンカーになります。

[out] ppRange

要求された範囲オブジェクトを受け取る ITfRange インターフェイス ポインターへのポインター。

[in] aPos

プロパティ範囲を取得するポイントとして使用する pRange のアンカーを指定する TfAnchor 値のいずれかを格納します。

戻り値

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

値 説明
S_OK
 メソッドは正常に実行されました。
S_FALSE
 pRange は、 プロパティを超えないか、隣接していません。 ppRange は NULL を受け取ります。
E_INVALIDARG
 1 つ以上のパラメーターが無効です。
E_OUTOFMEMORY
 メモリ割り当てエラーが発生しました。
E_FAIL
 未指定のエラーが発生しました。
TF_E_NOLOCK
 ec によって識別される編集コンテキストには、読み取り専用または読み取り/書き込みロックがありません。

解説

このメソッドは、 プロパティの空でない値を含むテキストの範囲を取得します。 プロパティに指定したポイントに値がない場合、 ppRange は NULL を 受け取り、メソッドは S_FALSEを返します。 次の例では、 aPos に TF_ANCHOR_STARTが含まれている場合、返される範囲には "is" が含まれます。 aPos にTF_ANCHOR_ENDが含まれている場合、プロパティが範囲の終点に存在しないため、メソッドはS_FALSEを返します。


COLOR: RRRRR   RR          GGGGGGGG
TEXT:  this <a>is som</a>e colored text

aPos にTF_ANCHOR_STARTが含まれている場合、このメソッドは開始アンカーの直前にあるプロパティ範囲を無視します。 同様 に、aPos に TF_ANCHOR_ENDが含まれている場合、このメソッドは終了アンカーの直後に開始されるプロパティ範囲を無視します。 次の例では、 aPos にTF_ANCHOR_STARTが含まれている場合、R 値プロパティは開始アンカー ポイントで終了し、G 値プロパティは開始アンカーから始まるため、返される範囲には "一部" ではなく "色付き" が含まれます。 aPos にTF_ANCHOR_ENDが含まれている場合、返される範囲には "text" ではなく "色付き" が含まれます。


COLOR:         RRRRR   GGGGGGGG    BBBB
TEXT:  this is some <a>colored </a>text

要件

   
サポートされている最小のクライアント 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

ITfProperty

ITfRange

TfAnchor