Edit

Share via

ITextStoreACPServices::Unserialize method (msctf.h)

  • Article

Takes previously serialized property data and applies it to a property object.

Syntax

HRESULT Unserialize(
  [in] ITfProperty                             *pProp,
  [in] const TF_PERSISTENT_PROPERTY_HEADER_ACP *pHdr,
  [in] IStream                                 *pStream,
  [in] ITfPersistentPropertyLoaderACP          *pLoader
);

Parameters

[in] pProp

Pointer to an ITfProperty object that receives the property data.

[in] pHdr

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

[in] pStream

Pointer to an IStream object that contains the property data. This parameter can be NULL if pLoader is not NULL. This parameter is ignored if pLoader is not NULL.

[in] pLoader

Pointer to an ITfPersistentPropertyLoaderACP object that the TSF manager will use to obtain the property data. This parameter can be NULL if pStream is not NULL.

Return value

This method can return one of these values.

Value Description
S_OK
 The method was successful.
TF_S_ASYNC
 The property data will be obtained asynchronously.
TF_E_SYNCHRONOUS
 A synchronous read-only lock cannot be obtained.
E_FAIL
 An unspecified error occurred.

Remarks

If pStream is specified rather than pLoader, the property data will be read from pStream during the call to Unserialize . If pLoader is specified rather than pStream, the property data will be read from pLoader asynchronously. Using pStream can cause long delays if the property data is large.

While 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

See also

ITextStoreACPServices interface, ITextStoreACPServices::Serialize, ITfContext::EnumProperties, ITfProperty interface, ITfRange interface, ITfReadOnlyProperty::EnumRanges, TF_PERSISTENT_PROPERTY_HEADER_ACP structure