CreateIconFromResource function

Creates an icon or cursor from resource bits describing the icon.

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

Syntax


HICON WINAPI CreateIconFromResource(
  _In_ PBYTE presbits,
  _In_ DWORD dwResSize,
  _In_ BOOL  fIcon,
  _In_ DWORD dwVer
);

Parameters

presbits [in]

Type: PBYTE

The buffer containing the icon or cursor resource bits. These bits are typically loaded by calls to the LookupIconIdFromDirectory, LookupIconIdFromDirectoryEx, and LoadResource functions.

dwResSize [in]

Type: DWORD

The size, in bytes, of the set of bits pointed to by the presbits parameter.

fIcon [in]

Type: BOOL

Indicates whether an icon or a cursor is to be created. If this parameter is TRUE, an icon is to be created. If it is FALSE, a cursor is to be created.

dwVer [in]

Type: DWORD

The version number of the icon or cursor format for the resource bits pointed to by the presbits parameter. The value must be greater than or equal to 0x00020000 and less than or equal to 0x00030000. This parameter is generally set to 0x00030000.

Return value

Type: HICON

If the function succeeds, the return value is a handle to the icon or cursor.

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

Remarks

The CreateIconFromResource, CreateIconFromResourceEx, CreateIconIndirect, GetIconInfo, LookupIconIdFromDirectory, and LookupIconIdFromDirectoryEx functions allow shell applications and icon browsers to examine and use resources throughout the system.

The CreateIconFromResource function calls CreateIconFromResourceEx passing LR_DEFAULTSIZE|LR_SHARED as flags.

When you are finished using the icon, destroy it using the DestroyIcon function.

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
CreateIconFromResourceEx
CreateIconIndirect
GetIconInfo
LoadResource
LookupIconIdFromDirectory
LookupIconIdFromDirectoryEx
Conceptual
Icons

 

 

Show: