Syntax
HRESULT Unserialize(
[in] ITfProperty *pProp,
[in] const 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 will use to obtain the property data. This parameter can be NULL if pStream is not NULL.
Return Value
The method can return one of the following 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
| Minimum supported client | Windows 2000 Professional |
| Minimum supported server | Windows 2000 Server |
| Redistributable | TSF 1.0 onWindows NT 4.0,Windows 2000 ProfessionalandWindows MeWindows 98 |
| Header | Msctf.idl and Msctf.h |
| DLL | Msctf.dll |
See Also
- ITextStoreACPServices
-
ITfProperty
-
TF_PERSISTENT_PROPERTY_HEADER_ACP
-
ITfPersistentPropertyLoaderACP
-
ITextStoreACPServices::Serialize
Send comments about this topic to Microsoft
Build date: 7/14/2009