LookupIconIdFromDirectoryEx
[Now
Supported on Windows NT]
The LookupIconIdFromDirectoryEx
function searches through icon or cursor data for the icon or cursor that best
fits the current display device.
int LookupIconIdFromDirectoryEx(
|
PBYTE presbits, |
// address
of resource data |
|
BOOL fIcon, |
// icon or
cursor flag |
|
int cxDesired, |
// desired
width of icon or cursor |
|
int cyDesired, |
// desired
height of icon or cursor |
|
UINT Flags |
// resource
flags |
|
); |
|
Parameters
presbits
Points to 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
Specifies
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
Specifies 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
Specifies 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
Specifies a
combination of the following values:
|
Value |
Meaning |
|
LR_DEFAULTCOLOR |
Uses the
default color format. |
|
LR_MONOCHROME |
Creates a
monochrome icon or cursor. |
Return Values
If the
function succeeds, the return value is an integer resource identifier for the
icon or cursor that best fits the current display device.
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.
See Also