ITfContextOwnerCompositionServices::TerminateComposition 方法 (msctf.h)
终止组合。
语法
HRESULT TerminateComposition(
[in] ITfCompositionView *pComposition
);
参数
[in] pComposition
指向表示要终止的合成的 ITfCompositionView 接口的指针。 如果此值为 NULL,则终止上下文中的所有组合。
返回值
此方法可以返回其中一个值。
值 | 说明 |
---|---|
|
方法成功。 |
|
上下文不在文档堆栈上。 |
|
文本服务当前对文档具有锁。 |
|
在另一个组合操作期间调用了此方法。 |
|
发生了未指定的错误。 |
注解
文本服务使用 ITfComposition::EndComposition 终止其创建的合成。
如果上下文所有者实现文本存储,则上下文所有者在调用此方法之前必须能够授予同步写入锁。
此方法还执行以下操作:
- 对于每个终止的合成,将对所有已安装的合成建议接收器调用 ITfCompositionSink::OnCompositionTerminated 。
- 如果上下文所有者安装了上下文所有者组合建议接收器,则会为每个终止的合成调用 ITfContextOwnerCompositionSink::OnEndComposition 。
- 将为每个终止的合成所涵盖的文本清除GUID_PROP_COMPOSING属性。
要求
要求 | 值 |
---|---|
最低受支持的客户端 | Windows 2000 专业版 [桌面应用 |UWP 应用] |
最低受支持的服务器 | Windows 2000 Server [桌面应用 |UWP 应用] |
目标平台 | Windows |
标头 | msctf.h |
DLL | Msctf.dll |
可再发行组件 | Windows 2000 专业版上的 TSF 1.0 |
另请参阅
ITfComposition::EndComposition, nf-msctf-itfcompositionsink-oncompositionterminated, ITfCompositionView 接口, ITfContextOwnerCompositionServices 接口, ITfContextOwnerCompositionSink::OnEndComposition