ITfRange::CompareEnd メソッド (msctf.h)

ITfRange::CompareEnd メソッドは、このテキスト範囲の終了アンカー位置を別の範囲のアンカーと比較します。

構文

HRESULT CompareEnd(
  [in]  TfEditCookie ec,
  [in]  ITfRange     *pWith,
  [in]  TfAnchor     aPos,
  [out] LONG         *plResult
);

パラメーター

[in] ec

ITfDocumentMgr::CreateContext または ITfEditSession::D oEditSession から取得した Cookie を編集します。

[in] pWith

アンカーがこの範囲終了アンカーと比較される指定範囲へのポインター。

[in] aPos

指定した pWith 範囲のどのアンカーをこの範囲の終了アンカーと比較するかを示す列挙要素。

説明
TF_ANCHOR_START
この範囲終了アンカーを、指定した範囲開始アンカーと比較します。
TF_ANCHOR_END
この範囲終了アンカーを、指定した範囲終了アンカーと比較します。

[out] plResult

この範囲の終了アンカーと指定された pWith 範囲のアンカーの比較結果へのポインター。

説明
-1
この終了アンカーは、指定した範囲のアンカー (指定した範囲のアンカーのこの終了アンカー < 位置の位置) の背後にあります。
0
この終了アンカーは、指定した範囲のアンカーと同じ位置にあります。
+1
この終了アンカーは、指定した範囲のアンカー (指定した範囲のアンカーのこの終了アンカー > 位置の位置) の前にあります。

戻り値

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

説明
S_OK
メソッドは正常に実行されました。
E_FAIL
未指定のエラーが発生しました。
E_INVALIDARG
1 つ以上のパラメーターが無効です。
TF_E_NOLOCK
ec パラメーターの値が無効な Cookie であるか、呼び出し元に読み取り専用ロックがありません。

解説

2 つのアンカーが 1 つのリージョンに存在しない限り、このメソッドは 0 を返しません。 呼び出し元で 2 つのアンカーが同じ場所に配置されているかどうかについての情報のみが必要な場合は、 ITfRange::IsEqualEnd の方が効率的です。

このメソッドは ITfRange::CompareStart と同じですが、この範囲の終了アンカーが別の指定範囲のアンカーと比較される点が除きます。

要件

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

ITfRange::CompareStart

ITfRange::IsEqualEnd

テキスト ストア

TfAnchor