LookupIconIdFromDirectoryEx function

Searches through icon or cursor data for the icon or cursor that best fits the current display device.

Syntax

int WINAPI LookupIconIdFromDirectoryEx(
  _In_ PBYTE presbits,
  _In_ BOOL  fIcon,
  _In_ int   cxDesired,
  _In_ int   cyDesired,
  _In_ UINT  Flags
);

Parameters

presbits [in]

Type: PBYTE

The icon or cursor directory data. Because this function does not validate the resource data, it causes a general protection (GP) fault or returns an undefined value if presbits is not pointing to valid resource data.

fIcon [in]

Type: BOOL

Indicates whether an icon or a cursor is sought. If this parameter is TRUE, the function is searching for an icon; if the parameter is FALSE, the function is searching for a cursor.

cxDesired [in]

Type: int

The desired width, in pixels, of the icon. If this parameter is zero, the function uses the SM_CXICON or SM_CXCURSOR system metric value.

cyDesired [in]

Type: int

The desired height, in pixels, of the icon. If this parameter is zero, the function uses the SM_CYICON or SM_CYCURSOR system metric value.

Flags [in]

Type: UINT

A combination of the following values.

Value	Meaning
LR_DEFAULTCOLOR 0x00000000	Uses the default color format.
LR_MONOCHROME 0x00000001	Creates a monochrome icon or cursor.

 

Return value

Type: int

If the function succeeds, the return value is an integer resource identifier for the icon or cursor that best fits the current display device.

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

Remarks

A resource file of type RT_GROUP_ICON (RT_GROUP_CURSOR indicates cursors) contains icon (or cursor) data in several device-dependent and device-independent formats. LookupIconIdFromDirectoryEx searches the resource file for the icon (or cursor) that best fits the current display device and returns its integer identifier. The FindResource and FindResourceEx functions use the MAKEINTRESOURCE macro with this identifier to locate the resource in the module.

The icon directory is loaded from a resource file with resource type RT_GROUP_ICON (or RT_GROUP_CURSOR for cursors), and an integer resource name for the specific icon to be loaded. LookupIconIdFromDirectoryEx returns an integer identifier that is the resource name of the icon that best fits the current display device.

The LoadIcon, LoadImage, and LoadCursor functions use this function to search the specified resource data for the icon or cursor that best fits the current display device.

Examples

For an example, see Sharing Icon Resources.

Requirements

See also

Reference

CreateIconFromResourceEx

CreateIconIndirect

FindResource

FindResourceEx

GetIconInfo

LoadCursor

LoadIcon

LoadImage

LookupIconIdFromDirectory

MAKEINTRESOURCE

Conceptual

Icons