LookupIconIdFromDirectory function

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

To specify a desired height or width, use the LookupIconIdFromDirectoryEx function.

Syntax


int WINAPI LookupIconIdFromDirectory(
  _In_ PBYTE presbits,
  _In_ BOOL  fIcon
);

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.

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. LookupIconIdFromDirectory 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. LookupIconIdFromDirectory returns an integer identifier that is the resource name of the icon that best fits the current display device.

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

Requirements

Minimum supported client

Windows 2000 Professional [desktop apps only]

Minimum supported server

Windows 2000 Server [desktop apps only]

Header

Winuser.h (include Windows.h)

Library

User32.lib

DLL

User32.dll

See also

Reference
CreateIconFromResource
CreateIconIndirect
FindResource
FindResourceEx
GetIconInfo
LoadCursor
LoadIcon
LoadImage
LookupIconIdFromDirectoryEx
MAKEINTRESOURCE
Conceptual
Icons

 

 

Community Additions

ADD
Show: