iTfDocumentMgr::P op 方法 (msctf.h)

从上下文堆栈顶部删除上下文。

语法

HRESULT Pop(
  [in] DWORD dwFlags
);

parameters

[in] dwFlags

如果此值为 0,则仅删除堆栈顶部的上下文。 如果此值TF_POPF_ALL,则会从堆栈中删除所有上下文。

返回值

此方法可以返回其中一个值。

说明
S_OK
方法成功。
E_FAIL
堆栈为空,或者调用此方法时没有TF_POPF_ALL标志,并且堆栈上只有一个上下文。
E_UNEXPECTED
此方法在另一个 ITfDocumentMgr::P op 调用期间调用。
E_INVALIDARG
dwFlags 无效。

注解

必须从与相应的 ITfDocumentMgr::P ush 调用相同的线程调用此方法。

添加到堆栈中的第一个上下文将成为主上下文。 如果不使用 TF_POPF_ALL 标志,则无法从堆栈中删除主上下文。 当文档未初始化时,应使用 TF_POPF_ALL 标志调用此方法。 这会导致文档管理器从上下文堆栈中删除所有上下文并终止任何文本服务 UI。 请勿在任何其他时间使用 TF_POPF_ALL 标志。

此方法会导致调用所有已安装的线程管理器事件接收器的 ITfThreadMgrEventSink::OnPopContext 方法。 如果从堆栈中删除最后一个上下文,此方法将导致调用所有已安装线程管理器事件接收器的 ITfThreadMgrEventSink::OnUninitDocumentMgr 方法。

要求

   
最低受支持的客户端 Windows 2000 专业版 [桌面应用 |UWP 应用]
最低受支持的服务器 Windows 2000 Server [桌面应用 |UWP 应用]
目标平台 Windows
标头 msctf.h
DLL Msctf.dll
可再发行组件 Windows 2000 专业版上的 TSF 1.0

另请参阅

ITfDocumentMgr

ITfDocumentMgr::P ush

ITfThreadMgrEventSink::OnPopContext

ITfThreadMgrEventSink::OnUninitDocumentMgr