ITfDocumentMgr::P ush メソッド (msctf.h)

[アーティクル]
03/08/2023

コンテキストスタックの先頭にコンテキストを追加します。

構文

HRESULT Push(
  [in] ITfContext *pic
);

パラメーター

[in] pic

スタックに追加する ITfContext オブジェクトへのポインター。このオブジェクトは、 ITfDocumentMgr::CreateContext に対する以前の呼び出しから取得されます。

戻り値

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

値	説明
S_OK	メソッドは正常に実行されました。
E_INVALIDARG	pic が無効です。
TF_E_STACKFULL	コンテキストのスタックに領域が存在しません。コンテキストスタックには、2 つのコンテキストの制限があります。
E_UNEXPECTED	このメソッドは、ITfDocumentMgr::P op 呼び出し中に呼び出されました。

注釈

スタックに追加された最初のコンテキストは、ドキュメントコンテキストメインになります。

TSF マネージャーおよびテキスト・サービスは、スタックの先頭にあるコンテキストとのみ対話します。通常、メインドキュメントコンテキストのみがスタック上にあります。場合によっては、2 つ目のコンテキストをスタックに追加する必要があります。たとえば、テキストサービスで候補リストなどのモーダル UI を表示する必要がある場合です。この間、テキストサービスはそのコンテキストをスタックに追加します。テキストサービス UI が不要になると、テキストサービスはスタックからコンテキストを削除します。その後、メインコンテキストはスタックの一番上に戻ります。このプロセスを簡略化し、複数のモーダル UI が表示されないようにするために、スタックで許可されるコンテキストは最大 2 つあります。

このメソッドにより、インストールされているすべてのスレッドマネージャーイベントシンクの ITfThreadMgrEventSink::OnPushContext メソッドが呼び出されます。これがスタックに追加される最初のコンテキストである場合、このメソッドは、インストールされているすべてのスレッドマネージャーイベントシンクの ITfThreadMgrEventSink::OnInitDocumentMgr メソッドを呼び出します。

コンテキストスタックからこのコンテキストを削除するには、ITfDocumentMgr::P op を呼び出す必要があります。

要件

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