ImageList_ReadEx function (commctrl.h)

Article
02/22/2024

Reads an image list from a stream, and returns an IImageList interface to the image list.

Syntax

HRESULT ImageList_ReadEx(
  [in]  DWORD   dwFlags,
  [in]  IStream *pstm,
  [out] REFIID  riid,
  [out] PVOID   *ppv
);

Parameters

[in] dwFlags

Type: DWORD

A flag that specifies how the stream is read.

Value	Meaning
ILP_NORMAL	Expects an image list that was written with the ILP_NORMAL flag specified.
ILP_DOWNLEVEL	Expects an image list that was written with the ILP_DOWNLEVEL flag specified.

[in] pstm

Type: LPSTREAM

The address of the stream.

[out] riid

Type: REFIID

An IID for the image list.

[out] ppv

Type: void**

The address of a pointer to the interface for the image list if successful, NULL otherwise.

Return value

Type: HRESULT

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

Remarks

To use ImageList_ReadEx, the application must specify Comctl32.dll version 6 in the manifest. For more information on manifests, see Enabling Visual Styles.

Requirements

Requirement	Value
Minimum supported client	Windows Vista [desktop apps only]
Minimum supported server	Windows Server 2003 [desktop apps only]
Target Platform	Windows
Header	commctrl.h
Library	Comctl32.lib
DLL	Comctl32.dll (version 6.0 or later)