Edit

Share via

IImageList::GetIcon method (commoncontrols.h)

  • Article

Creates an icon from an image and a mask in an image list.

Syntax

HRESULT GetIcon(
  [in]  int   i,
  [in]  UINT  flags,
  [out] HICON *picon
);

Parameters

[in] i

Type: int

A value of type int that contains the index of the image.

[in] flags

Type: UINT

A combination of flags that specify the drawing style. For a list of values, see IImageList::Draw.

[out] picon

Type: HICON*

A pointer to an int that contains the handle to the icon if successful, or NULL if otherwise.

Return value

Type: HRESULT

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

Remarks

The calling application must destroy the icon returned from this method using DestroyIcon.

To use IImageList::GetIcon, 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 commoncontrols.h
DLL Comctl32.dll (version 6.0 or later)