ITfDocumentMgr::P ush メソッド (msctf.h)
コンテキスト スタックの先頭にコンテキストを追加します。
構文
HRESULT Push(
[in] ITfContext *pic
);
パラメーター
[in] pic
スタックに追加する ITfContext オブジェクトへのポインター。 このオブジェクトは、 ITfDocumentMgr::CreateContext に対する以前の呼び出しから取得されます。
戻り値
このメソッドは、これらの値のいずれかを返すことができます。
| 値 | 説明 |
|---|---|
|
メソッドは正常に実行されました。 |
|
pic が無効です。 |
|
コンテキストのスタックに領域が存在しません。 コンテキスト スタックには、2 つのコンテキストの制限があります。 |
|
このメソッドは 、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 |