ITextStoreACPServices::Serialize method (msctf.h)

Article
10/13/2021

Obtains a property from a range of text and writes the property data into a stream object.

Syntax

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

Parameters

[in] pProp

Pointer to an ITfProperty interface that identifies the property to serialize.

[in] pRange

Pointer to an ITfRange interface that identifies the range that the property is obtained from.

[out] pHdr

Pointer to a TF_PERSISTENT_PROPERTY_HEADER_ACP structure that receives the header data for the property.

[in] pStream

Pointer to an IStream object that the TSF manager will write the property data to.

Return value

This method can return one of these values.

Value	Description
S_OK	The method was successful.
S_FALSE	The property cannot be serialized.
E_FAIL	An unspecified error occurred.

Remarks

The property header data placed in pHdr is generic to all properties and must be preserved with the data written into pStream. This same data pair must be passed to ITextStoreACPServices::Unserialize to restore the property data.

An application can save all of the properties for the entire document by performing the following steps.

Enumerate all properties using ITfContext::EnumProperties.
Within each property, enumerate the ranges using ITfReadOnlyProperty::EnumRanges.
Pass the current property and range to ITextStoreACPServices::Serialize.
Write the data placed in pHdr to the file.
Write the data added to pStream to the file.

When calling this method, the application must be able to grant a synchronous read-only lock.

Requirements

Requirement	Value
Minimum supported client	Windows 2000 Professional [desktop apps \| UWP apps]
Minimum supported server	Windows 2000 Server [desktop apps \| UWP apps]
Target Platform	Windows
Header	msctf.h
DLL	Msctf.dll
Redistributable	TSF 1.0 on Windows 2000 Professional