Export (0) Print
Expand All

DPA_LoadStream function

[DPA_LoadStream is available in Windows 2000 and Windows XP. It might be altered or unavailable in subsequent versions. ]

Loads the dynamic pointer array (DPA) from a stream by calling the specified callback function to read each element.

Syntax


HRESULT WINAPI DPA_LoadStream(
  _Out_  HDPA *ppdpa,
  _In_   PFNDPASTREAM pfn,
  _In_   IStream *pstm,
  _In_   void *pvInstData
);

Parameters

ppdpa [out]

Type: HDPA*

A handle to a DPA.

pfn [in]

Type: PFNDPASTREAM

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

pstm [in]

Type: IStream*

An IStream object.

pvInstData [in]

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 codeDescription
S_OK

Indicates that the callback function was successful and the element was loaded.

S_FALSE

Indicates that the callback function was unsuccessful in loading the element; however, the process should continue.

E_INVALIDARG

Indicates that one or more of the parameters is invalid.

E_FAIL

Indicates that the stream object could not be read.

E_OUTOFMEMORY

The buffer length is invalid or there was insufficient memory to complete the operation.

 

Remarks

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

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

Requirements

Minimum supported client

Windows 2000 Professional [desktop apps only]

Minimum supported server

Windows 2000 Server [desktop apps only]

Header

Commctrl.h

DLL

ComCtl32.dll

 

 

Community Additions

ADD
Show:
© 2014 Microsoft