ITextStoreACP::GetText メソッド (textstor.h)

ITextStoreACP::GetText メソッドは、指定した文字位置にあるテキストに関する情報を返します。 このメソッドは、表示されているテキストと非表示のテキストを返し、埋め込みデータがテキストに添付されているかどうかを示します。

構文

HRESULT GetText(
  [in]  LONG       acpStart,
  [in]  LONG       acpEnd,
  [out] WCHAR      *pchPlain,
  [in]  ULONG      cchPlainReq,
  [out] ULONG      *pcchPlainRet,
  [out] TS_RUNINFO *prgRunInfo,
  [in]  ULONG      cRunInfoReq,
  [out] ULONG      *pcRunInfoRet,
  [out] LONG       *pacpNext
);

パラメーター

[in] acpStart

開始文字の位置を指定します。

[in] acpEnd

終了文字の位置を指定します。 このパラメーターが -1 の場合は、テキスト ストア内のすべてのテキストを返します。

[out] pchPlain

プレーン テキスト データを受信するバッファーを指定します。 このパラメーターが NULL の場合、 cchPlainReq パラメーターは 0 である必要があります。

[in] cchPlainReq

メソッドに渡されるプレーン テキスト文字の数を指定します。

[out] pcchPlainRet

プレーン テキスト バッファーにコピーされた文字数を受け取ります。 このパラメーターを NULL にすることはできません。 値が必要ない場合は、 パラメーターを使用します。

[out] prgRunInfo

TS_RUNINFO構造体の配列を受け取ります。 cRunInfoReq = 0 の場合にのみ NULL を指定できます。

[in] cRunInfoReq

テキスト実行バッファーのサイズを文字数で指定します。

[out] pcRunInfoRet

テキスト実行バッファーに書き込まれた TS_RUNINFO 構造体の数を受け取ります。 このパラメーターを NULL にすることはできません。

[out] pacpNext

次の未読文字の文字位置を受け取ります。 NULL にすることはできません。

戻り値

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

値	説明
S_OK	メソッドは正常に実行されました。
TF_E_INVALIDPOS	acpStart パラメーターまたは acpEnd パラメーターは、ドキュメント テキストの外部にあります。
TF_E_NOLOCK	呼び出し元には、ドキュメントに対する読み取り専用ロックがありません。

注釈

このメソッドを使用する呼び出し元は、 ITextStoreACP::RequestLock メソッドを呼び出すことによって、ドキュメントの読み取り専用ロックを持っている必要があります。 読み取り専用ロックがないと、 メソッドは失敗し、 TF_E_NOLOCKを返します。

アプリケーションでは、内部的な理由からメソッドの戻り値を切り捨てることもできます。 呼び出し元は、戻り文字とテキスト実行数を慎重に調べて、必要な戻り値を取得する必要があります。 戻り値が不完全な場合は、戻り値が完了するまでメソッドを繰り返し呼び出します。

呼び出し元は、 cRunInfoReq パラメーターを 0 に設定し、 prgRunInfo パラメーターを NULL に設定することによってのみ、プレーン テキストを要求できます。 呼び出し元は、 cchPlainReq パラメーターを 0 に設定し、 pchPlain パラメーターを NULL に設定することで、テキスト実行データのみを要求できます。 ただし、このパラメーターが使用されていない場合でも、呼び出し元は pcchPlainRet に対して有効な null 以外の値を指定する必要があります。

acpEnd が -1 の場合は、ストリームの末尾に設定されているかのように処理する必要があります。 それ以外の場合は、0 以上になります。

終了時には、戻り値によって参照されないストリーム内の次の文字の文字位置に pacpNext を設定する必要があります。 呼び出し元はこれを使用して、複数の ITextStoreACP::GetText 呼び出しでテキストをすばやくスキャンします。

要件

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

こちらもご覧ください

ITextStoreACP

ITextStoreACP::RequestLock

マネージャーの戻り値

TS_RUNINFO