ITfDocumentMgr::P op メソッド (msctf.h)
コンテキスト スタックの先頭からコンテキストを削除します。
構文
HRESULT Pop(
[in] DWORD dwFlags
);
パラメーター
[in] dwFlags
この値が 0 の場合、スタックの上部にあるコンテキストのみが削除されます。 この値がTF_POPF_ALL場合、すべてのコンテキストがスタックから削除されます。
戻り値
このメソッドは、これらの値のいずれかを返すことができます。
| 値 | 説明 |
|---|---|
|
メソッドは正常に実行されました。 |
|
スタックが空であるか、このメソッドが TF_POPF_ALL フラグなしで呼び出され、スタック上に 1 つのコンテキストのみが含まれます。 |
|
このメソッドは、別の ITfDocumentMgr::P op 呼び出し中に呼び出されました。 |
|
dwFlags が無効です。 |
解説
このメソッドは、対応する ITfDocumentMgr::P ush 呼び出しと同じスレッドから呼び出す必要があります。
スタックに追加された最初のコンテキストがプライマリ コンテキストになります。 TF_POPF_ALL フラグを使用しないと、プライマリ コンテキストをスタックから削除できません。 ドキュメントが初期化されていない場合は、このメソッドを TF_POPF_ALL フラグで呼び出す必要があります。 これにより、ドキュメント マネージャーはコンテキスト スタックからすべてのコンテキストを削除し、テキスト サービス UI を終了します。 TF_POPF_ALL フラグは、他の時点では使用しないでください。
このメソッドにより、インストールされているすべてのスレッド マネージャー イベント シンクの ITfThreadMgrEventSink::OnPopContext メソッドが呼び出されます。 最後のコンテキストがスタックから削除された場合、このメソッドにより、インストールされているすべてのスレッド マネージャー イベント シンクの ITfThreadMgrEventSink::OnUninitDocumentMgr メソッドが呼び出されます。
要件
| サポートされている最小のクライアント | Windows 2000 Professional [デスクトップ アプリ |UWP アプリ] |
| サポートされている最小のサーバー | Windows 2000 Server [デスクトップ アプリ |UWP アプリ] |
| 対象プラットフォーム | Windows |
| ヘッダー | msctf.h |
| [DLL] | Msctf.dll |
| 再頒布可能パッケージ | Windows 2000 Professional 上の TSF 1.0 |