ITextStoreAnchor::GetText メソッド (textstor.h)
ITextStoreAnchor::GetText メソッドは、指定したアンカー位置にあるテキストに関する情報を返します。 このメソッドは、表示および非表示のテキストを返し、埋め込みデータがテキストに添付されているかどうかを示します。
構文
HRESULT GetText(
[in] DWORD dwFlags,
[in] IAnchor *paStart,
[in] IAnchor *paEnd,
[out] WCHAR *pchText,
[in] ULONG cchReq,
[out] ULONG *pcch,
[in] BOOL fUpdateAnchor
);
パラメーター
[in] dwFlags
使用されません。は 0 にする必要があります。
[in] paStart
開始アンカー位置を指定します。
[in] paEnd
終了アンカー位置を指定します。 NULL の場合は、テキスト ストリームの末尾に配置されたアンカーであるかのように扱われます。
[out] pchText
テキストを受信するバッファーを指定します。 cchReq = 0 の場合にのみ NULL を指定できます。
[in] cchReq
pchText バッファー サイズを文字で指定します。
[out] pcch
pchText バッファーにコピーされた文字数を受け取ります。
[in] fUpdateAnchor
TRUE の場合、paStart は pchText にコピーされた最後の文字の直前に再配置されます。
戻り値
このメソッドは、これらの値のいずれかを返すことができます。
| 値 | 説明 |
|---|---|
|
メソッドは正常に完了しました。 |
|
メソッドは、 paStart や paEnd への有効なインターフェイス ポインターを取得できませんでした。 |
|
paStart アンカーまたは paEnd アンカーは、ドキュメント テキストの外部にあります。 |
|
呼び出し元は、ドキュメントに対する読み取り専用ロックを持っていません。 |
解説
このメソッドを使用する呼び出し元は、 ITextStoreAnchor::RequestLock メソッドを呼び出すことによって、ドキュメントの読み取り専用ロックを持っている必要があります。 読み取り専用ロックがないと、 メソッドは失敗し、 TF_E_NOLOCKを返します。
アプリケーションでは、内部的な理由により、メソッドの戻り値を切り捨てることができます。
複数の GetText 呼び出しでテキストをすばやくスキャンするために、呼び出し元は fUpdateAnchor = TRUE を使用します。
paStart と paEnd の間の文字数が cchReq より小さい場合、コピーされる実際の文字数は cchReq 未満になる可能性があります。
GetText の動作は、返されるテキストの対象となる領域境界の影響を受けません。
要件
| サポートされている最小のクライアント | Windows 2000 Professional [デスクトップ アプリ |UWP アプリ] |
| サポートされている最小のサーバー | Windows 2000 Server [デスクトップ アプリ |UWP アプリ] |
| 対象プラットフォーム | Windows |
| ヘッダー | textstor.h |
| [DLL] | Msctf.dll |
| 再頒布可能パッケージ | Windows 2000 Professional 上の TSF 1.0 |