Windows Dev Center

Information
The topic you requested is included in another documentation set. For convenience, it's displayed below. Choose Switch to see the topic in its original location.

ITfContextOwnerServices::Unserialize method

Syntax


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

Parameters

pProp [in]

Pointer to an ITfProperty object that receives the property data.

pHdr [in]

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

pStream [in]

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.

pLoader [in]

Pointer to an ITfPersistentPropertyLoaderACP object that the TSF manager uses 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.

ValueDescription
S_OK

The method was successful.

TF_S_ASYNC

The property data is 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 is read from pStream during the call to this method. If pLoader is specified rather than pStream, the property data is read from pLoader asynchronously. Using pStream can cause long delays if the property data is large.

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

Requirements

Minimum supported client

Windows 2000 Professional [desktop apps | Windows Store apps]

Minimum supported server

Windows 2000 Server [desktop apps | Windows Store apps]

Redistributable

TSF 1.0 on Windows 2000 Professional

Header

Msctf.h

IDL

Msctf.idl

DLL

Msctf.dll

See also

ITfContextOwnerServices
ITfProperty
TF_PERSISTENT_PROPERTY_HEADER_ACP
ITfContextOwnerServices::Serialize
ITfPersistentPropertyLoaderACP

 

 

Community Additions

Show:
© 2015 Microsoft