IImageList::GetOverlayImage method (commoncontrols.h)

Retrieves a specified image from the list of images used as overlay masks.

Syntax

HRESULT GetOverlayImage(
  [in]  int iOverlay,
  [out] int *piIndex
);

Parameters

[in] iOverlay

Type: int

A value of type int that contains the one-based index of the overlay mask.

[out] piIndex

Type: int*

A pointer to an int that receives the zero-based index of
an image in the image list. This index identifies the image that is used as an overlay mask.

Return value

Type: HRESULT

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

Remarks

To use IImageList::GetOverlayImage, specify Comctl32.dll version 6 in the manifest. For more information on manifests, see Enabling Visual Styles.

Requirements