IPersistSerializedPropStorage::GetPropertyStorage method (propsys.h)

Article
02/22/2024

Gets the serialized property storage data from the property store instance.

Syntax

HRESULT GetPropertyStorage(
  [out] SERIALIZEDPROPSTORAGE **ppsps,
  [out] DWORD                 *pcb
);

Parameters

[out] ppsps

Type: SERIALIZEDPROPSTORAGE**

When this method returns, contains the address of a pointer to the serialized property storage data.

[out] pcb

Type: DWORD*

When this method returns, contains the count of bytes contained in the serialized property storage data pointed to by ppsps.

Return value

Type: HRESULT

If this method succeeds, it returns S_OK. Otherwise, it returns an HRESULT error code.

Remarks

The SERIALIZEDPROPSTORAGE type is defined in Propsys.h as an incomplete type. It should be treated as an array of BYTE values; the format of the returned data is not specified. The contents of the SERIALIZEDPROPSTORAGE structure are suitable for persisting to disk or other storage and can be used to initialize another property store through IPersistSerializedPropStorage::SetPropertyStorage.

Note It is the responsibility of the application that calls IPersistSerializedPropStorage::GetPropertyStorage to later call CoTaskMemFree to release the memory referred to by ppsps when it is no longer needed.

Requirements

Requirement	Value
Minimum supported client	Windows Vista [desktop apps only]
Minimum supported server	Windows Server 2008 [desktop apps only]
Target Platform	Windows
Header	propsys.h

Share via