FindResource Function

Determines the location of a resource with the specified type and name in the specified module.

To specify a language, use the FindResourceEx function.

Syntax

HRSRC FindResource(      
    HMODULE hModule,     LPCTSTR lpName,     LPCTSTR lpType );

Parameters

hModule
[in] Handle to the module whose portable executable file or an accompanying MUI file contains the resource. If this parameter is NULL, the function searches the module used to create the current process.
lpName
[in] Specifies the name of the resource. For more information, see the Remarks section below.
lpType
[in] Specifies the resource type. For more information, see the Remarks section below. For standard resource types, see Resource Types.

Return Value

If the function succeeds, the return value is a handle to the specified resource's information block. To obtain a handle to the resource, pass this handle to the LoadResource function.

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

Remarks

If IS_INTRESOURCE(x) is TRUE for x = lpName or lpType, x specifies the integer identifier of the name or type of the given resource. Otherwise, those parameters are long pointers to null-terminated strings. If the first character of the string is a pound sign (#), the remaining characters represent a decimal number that specifies the integer identifier of the resource's name or type. For example, the string "#258" represents the integer identifier 258.

To reduce the amount of memory required for a resource, an application should refer to it by integer identifier instead of by name.

An application can use FindResource to find any type of resource, but this function should be used only if the application must access the binary resource data by making subsequent calls to LoadResource and then to LockResource.

To use a resource immediately, an application should use one of the following resource-specific functions to find the resource and convert the data into a more usable form.

FunctionAction
FormatMessageLoads and formats a message-table entry.
LoadAcceleratorsLoads an accelerator table.
LoadBitmapLoads a bitmap resource.
LoadCursorLoads a cursor resource.
LoadIconLoads an icon resource.
LoadMenuLoads a menu resource.
LoadStringLoads a string-table entry.

For example, an application can use the LoadIcon function to load an icon for display on the screen. However, the application should use FindResource and LoadResource if it is loading the icon to copy its data to another application.

String resources are stored in sections of up to 16 strings per section. The strings in each section are stored as a sequence of counted (not necessarily null-terminated) Unicode strings. The LoadString function will extract the string resource from its corresponding section.

Windows 95/98/Me:The lpType and lpName parameters to FindResourceW may not be string buffers allocated from the heap. If necessary, copy them to stack buffers and pass the stack buffers.

Windows 95/98/Me: Although FindResourceW exists on Microsoft Windows 95, Windows 98, and Windows Millennium Edition (Windows Me), it is supported by the Microsoft Layer for Unicode (MSLU) to provide more consistent behavior across all Windows operating systems. To use this, you must add certain files to your application, as outlined in Microsoft Layer for Unicode on Windows 95/98/Me Systems.

Example

For an example, see Updating Resources.

Function Information

Minimum DLL Versionkernel32.dll
HeaderDeclared in Winbase.h, include Windows.h
Import libraryKernel32.lib
Minimum operating systems Windows 95, Windows NT 3.1
UnicodeImplemented as ANSI and Unicode versions.

See Also

Tags :


Community Content

Matt Green
Having trouble loading resources by name?
Unfortunately, the official documentation does not mention that loading a resource by name does not work unless you specify the name in all capital letters. The resource itself must be named with all capital letters, and the argument to FindResource[Ex] must be in all capital letters. Otherwise, FindResource[Ex] will return NULL with error code 1814.
Tags : resource

Stefan Brueggemann
Caution with PNG images

If you try to include PNG images in a resource file, be aware that PNG seems to be a standard resource type although the MSDN does NOT list it as such (neither http://msdn.microsoft.com/en-us/library/ms648009(VS.85).aspx nor http://msdn.microsoft.com/en-us/library/aa381043(VS.85).aspx list PNG as standard type). Using the resource compiler RC.exe with a .rc file containing entries like

PNGFILE PNG PNGFILE.PNG



where a new custom resource type named "PNG" is defined will result in unexpected behaviour when trying to retrieve a handle to such a resource using FindResource() and passing the type as name instead of ID. It will cause an error code 1813 (The specified resource type cannot be found in the image file.). Even more, the resource will be treated as a bitmap and not as custom binary data (RCDATA).

Tags : resource png

Page view tracker