LoadIcon
The LoadIcon
function loads the specified icon resource from the executable (.EXE) file
associated with an application instance.
HICON LoadIcon(
|
HINSTANCE hInstance, |
// handle of
application instance |
|
LPCTSTR lpIconName |
// icon-name string
or icon resource identifier |
|
); |
|
Parameters
hInstance
Identifies an
instance of the module whose executable file contains the icon to be loaded.
This parameter must be NULL when a standard icon is being loaded.
lpIconName
Points to a
null-terminated string that contains the name of the icon resource to be loaded.
Alternatively, this parameter can contain the resource identifier in the
low-order word and zero in the high-order word. Use the MAKEINTRESOURCE macro to create this value.
To use one of the Windows predefined icons, set the hInstance
parameter to NULL and the lpIconName parameter to one of the following
values:
|
Value |
Description |
|
IDI_APPLICATION |
Default
application icon. |
|
IDI_ASTERISK |
Asterisk
(used in informative messages). |
|
IDI_EXCLAMATION |
Exclamation
point (used in warning messages). |
|
IDI_HAND |
Hand-shaped
icon (used in serious warning messages). |
|
IDI_QUESTION |
Question
mark (used in prompting messages). |
|
IDI_WINLOGO |
Windows
logo. |
Return Values
If the
function succeeds, the return value is the handle of the newly loaded icon.
If the
function fails, the return value is NULL. To get extended error information,
call GetLastError.
Remarks
LoadIcon loads the icon resource only if it has not been
loaded; otherwise, it retrieves a handle to the existing resource. The function
searches the icon resource for the icon most appropriate for the current
display. The icon resource can be a color or monochrome bitmap.
LoadIcon can only load an icon whose size conforms to the
SM_CXICON and SM_CYICON system metric values. Use the LoadImage function
to load icons of other sizes.
See Also