Edit

Share via

DPA_SaveStream function (dpa_dsa.h)

  • Article

[DPA_SaveStream is available in Windows Vista. It might be altered or unavailable in subsequent versions. ]

Saves the dynamic pointer array (DPA) to a stream by writing out a header, and then calling the specified callback function to write each element.

Syntax

HRESULT DPA_SaveStream(
  [in] HDPA         hdpa,
  [in] PFNDPASTREAM pfn,
  [in] IStream      *pstream,
  [in] void         *pvInstData
);

Parameters

[in] hdpa

Type: HDPA

Receives a handle to a DPA.

[in] pfn

Type: PFNDPASTREAM

The callback function. See PFNDPASTREAM for the callback function prototype.

[in] pstream

Type: IStream*

An IStream object.

[in] pvInstData

Type: void*

A pointer to callback data. pvInstData is passed as a parameter to pfn.

Return value

Type: HRESULT

Returns one of the following values.

Return code Description
S_OK
 Indicates that the callback function was unsuccessful in saving the element; however, the process should continue.
S_FALSE
 Indicates that even though the callback was unsuccessful, the process was uninterrupted.
E_INVALIDARG
 Indicates that one or more of the parameters is invalid.

Remarks

This function must be called directly from ComCtl32.dll. It is ordinal 10.

The callback is responsible for writing the pvInstData data to the stream.

Requirements

Requirement Value
Minimum supported client Windows Vista [desktop apps only]
Minimum supported server Windows Server 2003 [desktop apps only]
Target Platform Windows
Header dpa_dsa.h
DLL ComCtl32.dll