GetIconInfo

The GetIconInfo function retrieves information about the specified icon or cursor.

BOOL GetIconInfo(
  HICON hIcon,          // icon handle
  PICONINFO piconinfo   // address of icon structure
);
 

Parameters

hIcon

Handle to the icon or cursor. To retrieve information about a standard icon or cursor, specify one of the following values:

Value	Meaning
IDC_APPSTARTING	Standard arrow and small hourglass cursor
IDC_ARROW	Standard arrow cursor
IDC_CROSS	Crosshair cursor
IDC_HAND	Windows NT 5.0 and later: Hand cursor
IDC_HELP	Arrow and question mark cursor
IDC_IBEAM	I-beam cursor
IDC_NO	Slashed circle cursor
IDC_SIZEALL	Four-pointed arrow cursor pointing north, south, east, and west
IDC_SIZENESW	Double-pointed arrow cursor pointing northeast and southwest
IDC_SIZENS	Double-pointed arrow cursor pointing north and south
IDC_SIZENWSE	Double-pointed arrow cursor pointing northwest and southeast
IDC_SIZEWE	Double-pointed arrow cursor pointing west and east
IDC_UPARROW	Vertical arrow cursor
IDC_WAIT	Hourglass cursor
IDI_APPLICATION	Application icon
IDI_ASTERISK	Asterisk icon
IDI_EXCLAMATION	Exclamation point icon
IDI_HAND	Stop sign icon
IDI_QUESTION	Question-mark icon
IDI_WINLOGO	Windows logo icon

piconinfo

Pointer to an ICONINFO structure. The function fills in the structure's members.

Return Values

If the function succeeds, the return value is nonzero and the function fills in the members of the specified ICONINFO structure.

If the function fails, the return value is zero. To get extended error information, call GetLastError.

Remarks

GetIconInfo creates bitmaps for the hbmMask and hbmColor members of ICONINFO. The calling application must manage these bitmaps and delete them when they are no longer necessary.

QuickInfo

  Windows NT: Requires version 3.1 or later.
  Windows: Requires Windows 95 or later.
  Windows CE: Unsupported.
  Header: Declared in winuser.h.
  Import Library: Use user32.lib.

See Also

Icons Overview, Icon Functions, CreateIcon, CreateIconFromResource, CreateIconIndirect, DestroyIcon, DrawIcon, DrawIconEx, ICONINFO, LoadIcon, LookupIconIdFromDirectory