ITextStoreACPServices::Serialize 方法 (msctf.h)

从文本范围获取属性,并将属性数据写入流对象。

语法

HRESULT Serialize(
  [in]  ITfProperty                       *pProp,
  [in]  ITfRange                          *pRange,
  [out] TF_PERSISTENT_PROPERTY_HEADER_ACP *pHdr,
  [in]  IStream                           *pStream
);

参数

[in] pProp

指向标识要序列化的属性的 ITfProperty 接口的指针。

[in] pRange

指向 ITfRange 接口的指针,该接口标识从中获取属性的范围。

[out] pHdr

指向接收属性标头数据的 TF_PERSISTENT_PROPERTY_HEADER_ACP 结构的指针。

[in] pStream

指向 TSF 管理器将向其写入属性数据的 IStream 对象的指针。

返回值

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

说明
S_OK
方法成功。
S_FALSE
无法序列化 属性。
E_FAIL
发生了未指定的错误。

注解

放置在 pHdr 中的属性标头数据对所有属性都是通用的,并且必须与写入 pStream 中的数据一起保留。 必须将此相同的数据对传递给 ITextStoreACPServices::Unserialize 才能还原属性数据。

应用程序可以通过执行以下步骤来保存整个文档的所有属性。

调用此方法时,应用程序必须能够授予同步只读锁。

要求

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

另请参阅

ITextStoreACPServices 接口ITextStoreACPServices::UnserializeITfContext::EnumPropertiesITfProperty 接口ITfRange 接口ITfReadOnlyProperty::EnumRanges、TF_PERSISTENT_PROPERTY_HEADER_ACP 结构