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

  • [アーティクル]

ITextStoreACP::InsertTextAtSelection メソッドは、挿入ポイントまたは選択範囲にテキストを挿入します。 呼び出し元は、テキストを挿入する前に、ドキュメントの読み取り/書き込みロックを持っている必要があります。

構文

HRESULT InsertTextAtSelection(
  [in]  DWORD         dwFlags,
  [in]  const WCHAR   *pchText,
  [in]  ULONG         cch,
  [out] LONG          *pacpStart,
  [out] LONG          *pacpEnd,
  [out] TS_TEXTCHANGE *pChange
);

パラメーター

[in] dwFlags

pacpStart パラメーターと pacpEnd パラメーター、およびTS_TEXTCHANGE構造体にテキスト挿入の結果を含めるかどうかを指定します。

TF_IAS_NOQUERYフラグとTF_IAS_QUERYONLY フラグを組み合わせることはできません。

値 意味
0
 テキストの挿入が行われ、 pacpStart パラメーターと pacpEnd パラメーターにはテキスト挿入の結果が含まれます。 TS_TEXTCHANGE構造体には、このフラグを入力する必要があります。
TF_IAS_NOQUERY
 テキストが挿入され、 pacpStart パラメーターと pacpEnd パラメーターの値は NULL にすることができ、 TS_TEXTCHANGE 構造体を入力する必要があります。 このフラグを使用して、テキスト挿入の結果を表示します。
TF_IAS_QUERYONLY
 テキストは挿入されず、 pacpStart パラメーターと pacpEnd パラメーターの値にはテキスト挿入の結果が含まれます。 これらのパラメーターの値は、アプリケーションがドキュメントへのテキスト挿入を実装する方法によって異なります。 詳細については、「解説」を参照してください。 実際にテキストを挿入せずにテキスト挿入の結果を表示するには、このフラグを使用します。 このフラグを使用する場合は 、TS_TEXTCHANGE 構造体を入力する必要はありません。

[in] pchText

ドキュメントに挿入する文字列へのポインター。 文字列は NULL で終了できます。

[in] cch

テキストの長さを指定します。

[out] pacpStart

テキストの挿入が行われる開始アプリケーション文字位置へのポインター。

[out] pacpEnd

テキストの挿入が行われる終了アプリケーション文字位置へのポインター。 このパラメーター値は、挿入ポイントの pacpStart パラメーターの値と同じです。

[out] pChange

次のメンバーを 持つTS_TEXTCHANGE 構造体へのポインター。

値 意味
acpStart
 テキストがドキュメントに挿入される前の開始アプリケーションの文字位置。
acpOldEnd
 テキストがドキュメントに挿入される前の終了アプリケーションの文字位置。 この値は、挿入ポイントの acpStart と同じです。 この値が acpStart と異なる場合は、テキストの挿入前にテキストが選択されていました。
acpNewEnd
 テキストの挿入後の終了位置。

戻り値

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

値 説明
S_OK
 メソッドは正常に実行されました。
TS_E_NOLOCK
 呼び出し元には、ドキュメントに対するロックがありません。
E_INVALIDARG
 pchText パラメーターが無効です。

注釈

pacpStart パラメーターと pacpEnd パラメーターの値は、クライアント アプリケーションがドキュメントにテキストを挿入する方法によって異なります。 たとえば、アプリケーションがテキストの挿入後に挿入されたテキストの先頭にカーソルを設定する場合、pacpStart パラメーターと pacpEnd パラメーターの値は、TS_TEXTCHANGE構造体の acpStart メンバーと同じです。

アプリケーションでは、このメソッドに応答して ITextStoreACPSink::OnTextChange メソッドを呼び出さないでください。

要件

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

こちらもご覧ください

組成

ITextStoreACP

ITextStoreACPSink::OnTextChange

TF_IAS_* 定数

TS_TEXTCHANGE