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
Identifies the icon or cursor. To retrieve information about a standard icon or cursor, specify one of the following values:
Value | Meaning |
IDC_ARROW | Arrow cursor |
IDC_IBEAM | I-beam cursor |
IDC_WAIT | Hourglass cursor |
IDC_CROSS | Crosshair cursor |
IDC_UPARROW | Up arrow cursor |
IDC_SIZENWSE | Sizing cursor, points northwest and southeast |
IDC_SIZENESW | Sizeing cursor, points northeast and southwest |
IDC_SIZEWE | Sizing cursor, points west and east |
IDC_SIZENS | Sizing cursor, points north and south |
IDC_SIZEALL | Sizing cursor, points north, south, east, and west |
IDC_NO | "No" cursor |
IDC_APPSTARTING | Application-starting cursor (arrow and hourglass) |
IDC_HELP | Help cursor (arrow and question mark) |
IDI_APPLICATION | Application icon |
IDI_HAND | Stop sign icon |
IDI_QUESTION | Question-mark icon |
IDI_EXCLAMATION | Exclamation point icon |
IDI_ASTERISK | Asterisk icon (letter "i" in a circle) |
IDI_WINLOGO | Windows logo icon |
piconinfo
Points 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.
See Also
CreateIcon, CreateIconFromResource, CreateIconIndirect, DestroyIcon, DrawIcon, DrawIconEx, ICONINFO, LoadIcon, LookupIconIdFromDirectory