Skip to content

EnumResource* articles update #2210

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
nikita-leontiev wants to merge 1 commit into
base: docs
Choose a base branch
from
Open

EnumResource* articles update #2210

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion sdk-api-src/content/libloaderapi/nc-libloaderapi-enumreslangproca.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -121,4 +121,4 @@ If the callback function returns **FALSE**, then [**EnumResourceLanguagesA**](..

[**MAKELANGID**](../winnt/nf-winnt-makelangid.md)

[Resources](/windows/win32/menurc/resources)
[Menus and Other Resources](/windows/win32/menurc/resources)
2 changes: 1 addition & 1 deletion sdk-api-src/content/libloaderapi/nc-libloaderapi-enumreslangprocw.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -121,4 +121,4 @@ If the callback function returns **FALSE**, then [**EnumResourceLanguagesW**](..

[**MAKELANGID**](../winnt/nf-winnt-makelangid.md)

[Resources](/windows/win32/menurc/resources)
[Menus and Other Resources](/windows/win32/menurc/resources)
6 changes: 3 additions & 3 deletions sdk-api-src/content/libloaderapi/nc-libloaderapi-enumresnameproca.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -61,13 +61,13 @@ A handle to the module whose executable file contains the resources that are bei

### -param lpType

Type: <b>LPCTSTR</b>
Type: <b>LPCSTR</b>

The type of resource for which the name is being enumerated. Alternately, rather than a pointer, this parameter can be <code>MAKEINTRESOURCE(ID)</code>, where ID is an integer value representing a predefined resource type. For standard resource types, see <a href="/windows/desktop/menurc/resource-types">Resource Types</a>. For more information, see the Remarks section below.

### -param lpName

Type: <b>LPTSTR</b>
Type: <b>LPSTR</b>

The name of a resource of the type being enumerated. Alternately, rather than a pointer, this parameter can be <code>MAKEINTRESOURCE(ID)</code>, where ID is the integer identifier of the resource. For more information, see the Remarks section below.

Expand Down Expand Up @@ -118,4 +118,4 @@ If the callback function returns <b>FALSE</b>, then <a href="/windows/win32/api/



<a href="https://msdn.microsoft.com/ff321356-c999-4021-a537-fbe863996e24">Resources</a>
<a href="/windows/desktop/menurc/resources">Menus and Other Resources</a>
18 changes: 9 additions & 9 deletions sdk-api-src/content/libloaderapi/nc-libloaderapi-enumresnameprocw.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -49,7 +49,7 @@ api_name:

## -description

An application-defined callback function used with the <a href="/windows/win32/api/libloaderapi/nf-libloaderapi-enumresourcenamesa">EnumResourceNames</a> and <a href="/windows/win32/api/libloaderapi/nf-libloaderapi-enumresourcenamesexa">EnumResourceNamesEx</a> functions. It receives the type and name of a resource. The <b>ENUMRESNAMEPROC</b> type defines a pointer to this callback function. <i>EnumResNameProc</i> is a placeholder for the application-defined function name.
An application-defined callback function used with the <a href="/windows/win32/api/libloaderapi/nf-libloaderapi-enumresourcenamesw">EnumResourceNames</a> and <a href="/windows/win32/api/libloaderapi/nf-libloaderapi-enumresourcenamesexw">EnumResourceNamesEx</a> functions. It receives the type and name of a resource. The <b>ENUMRESNAMEPROC</b> type defines a pointer to this callback function. <i>EnumResNameProc</i> is a placeholder for the application-defined function name.

## -parameters

Expand All @@ -61,21 +61,21 @@ A handle to the module whose executable file contains the resources that are bei

### -param lpType

Type: <b>LPCTSTR</b>
Type: <b>LPCWSTR</b>

The type of resource for which the name is being enumerated. Alternately, rather than a pointer, this parameter can be <code>MAKEINTRESOURCE(ID)</code>, where ID is an integer value representing a predefined resource type. For standard resource types, see <a href="/windows/desktop/menurc/resource-types">Resource Types</a>. For more information, see the Remarks section below.

### -param lpName

Type: <b>LPTSTR</b>
Type: <b>LPWSTR</b>

The name of a resource of the type being enumerated. Alternately, rather than a pointer, this parameter can be <code>MAKEINTRESOURCE(ID)</code>, where ID is the integer identifier of the resource. For more information, see the Remarks section below.

### -param lParam [in]

Type: <b>LONG_PTR</b>

An application-defined parameter passed to the <a href="/windows/win32/api/libloaderapi/nf-libloaderapi-enumresourcenamesa">EnumResourceNames</a> or <a href="/windows/win32/api/libloaderapi/nf-libloaderapi-enumresourcenamesexa">EnumResourceNamesEx</a> function. This parameter can be used in error checking.
An application-defined parameter passed to the <a href="/windows/win32/api/libloaderapi/nf-libloaderapi-enumresourcenamesw">EnumResourceNames</a> or <a href="/windows/win32/api/libloaderapi/nf-libloaderapi-enumresourcenamesexw">EnumResourceNamesEx</a> function. This parameter can be used in error checking.

## -returns

Expand All @@ -89,9 +89,9 @@ If <a href="/windows/win32/api/winuser/nf-winuser-is_intresource">IS_INTRESOURCE

Similarly, if <a href="/windows/win32/api/winuser/nf-winuser-is_intresource">IS_INTRESOURCE</a>(<i>lpszName</i>) is <b>TRUE</b>, then <i>lpszName</i> specifies the integer identifier of the given resource. Otherwise, it is a pointer to a null-terminated string. If the first character of the string is a pound sign (#), then the remaining characters represent a decimal number that specifies the integer identifier of the resource.

An application must register this function by passing its address to the <a href="/windows/win32/api/libloaderapi/nf-libloaderapi-enumresourcenamesa">EnumResourceNames</a> or <a href="/windows/win32/api/libloaderapi/nf-libloaderapi-enumresourcenamesexa">EnumResourceNamesEx</a> function.
An application must register this function by passing its address to the <a href="/windows/win32/api/libloaderapi/nf-libloaderapi-enumresourcenamesw">EnumResourceNames</a> or <a href="/windows/win32/api/libloaderapi/nf-libloaderapi-enumresourcenamesexw">EnumResourceNamesEx</a> function.

If the callback function returns <b>FALSE</b>, then <a href="/windows/win32/api/libloaderapi/nf-libloaderapi-enumresourcenamesa">EnumResourceNames</a> or <a href="/windows/win32/api/libloaderapi/nf-libloaderapi-enumresourcenamesexa">EnumResourceNamesEx</a> will stop enumeration and return <b>FALSE</b>. On Windows XP and earlier the value obtained from <a href="/windows/desktop/api/errhandlingapi/nf-errhandlingapi-getlasterror">GetLastError</a> will be <b>ERROR_SUCCESS</b>; starting with Windows Vista, the last error value will be <b>ERROR_RESOURCE_ENUM_USER_STOP</b>.
If the callback function returns <b>FALSE</b>, then <a href="/windows/win32/api/libloaderapi/nf-libloaderapi-enumresourcenamesw">EnumResourceNames</a> or <a href="/windows/win32/api/libloaderapi/nf-libloaderapi-enumresourcenamesexw">EnumResourceNamesEx</a> will stop enumeration and return <b>FALSE</b>. On Windows XP and earlier the value obtained from <a href="/windows/desktop/api/errhandlingapi/nf-errhandlingapi-getlasterror">GetLastError</a> will be <b>ERROR_SUCCESS</b>; starting with Windows Vista, the last error value will be <b>ERROR_RESOURCE_ENUM_USER_STOP</b>.

> [!NOTE]
> The libloaderapi.h header defines ENUMRESNAMEPROC as an alias that automatically selects the ANSI or Unicode version of this function based on the definition of the UNICODE preprocessor constant. Mixing usage of the encoding-neutral alias with code that is not encoding-neutral can lead to mismatches that result in compilation or runtime errors. For more information, see [Conventions for Function Prototypes](/windows/win32/intl/conventions-for-function-prototypes).
Expand All @@ -102,11 +102,11 @@ If the callback function returns <b>FALSE</b>, then <a href="/windows/win32/api/



<a href="/windows/win32/api/libloaderapi/nf-libloaderapi-enumresourcenamesa">EnumResourceNames</a>
<a href="/windows/win32/api/libloaderapi/nf-libloaderapi-enumresourcenamesw">EnumResourceNames</a>



<a href="/windows/win32/api/libloaderapi/nf-libloaderapi-enumresourcenamesexa">EnumResourceNamesEx</a>
<a href="/windows/win32/api/libloaderapi/nf-libloaderapi-enumresourcenamesexw">EnumResourceNamesEx</a>



Expand All @@ -118,4 +118,4 @@ If the callback function returns <b>FALSE</b>, then <a href="/windows/win32/api/



<a href="https://msdn.microsoft.com/ff321356-c999-4021-a537-fbe863996e24">Resources</a>
<a href="/windows/desktop/menurc/resources">Menus and Other Resources</a>
9 changes: 7 additions & 2 deletions sdk-api-src/content/libloaderapi/nc-libloaderapi-enumrestypeproca.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -61,7 +61,7 @@ A handle to the module whose executable file contains the resources for which th

### -param lpType

Type: <b>LPTSTR</b>
Type: <b>LPSTR</b>

The type of resource for which the type is being enumerated.

Expand Down Expand Up @@ -94,12 +94,17 @@ If the callback function returns <b>FALSE</b>, then <a href="/windows/win32/api/

<b>Conceptual</b>


<a href="/windows/win32/api/winbase/nf-winbase-enumresourcetypesa">EnumResourceTypes</a>


<a href="/windows/win32/api/libloaderapi/nf-libloaderapi-enumresourcetypesexa">EnumResourceTypesEx</a>


<a href="/windows/win32/api/winuser/nf-winuser-is_intresource">IS_INTRESOURCE</a>


<b>Reference</b>

<a href="https://msdn.microsoft.com/ff321356-c999-4021-a537-fbe863996e24">Resources</a>

<a href="/windows/desktop/menurc/resources">Menus and Other Resources</a>
23 changes: 9 additions & 14 deletions sdk-api-src/content/libloaderapi/nc-libloaderapi-enumrestypeprocw.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -49,7 +49,7 @@ api_name:

## -description

An application-defined callback function used with the <a href="/windows/win32/api/winbase/nf-winbase-enumresourcetypesa">EnumResourceTypes</a> and <a href="/windows/win32/api/libloaderapi/nf-libloaderapi-enumresourcetypesexa">EnumResourceTypesEx</a> functions. It receives resource types. The <b>ENUMRESTYPEPROC</b> type defines a pointer to this callback function. <i>EnumResTypeProc</i> is a placeholder for the application-defined function name.
An application-defined callback function used with the <a href="/windows/win32/api/winbase/nf-winbase-enumresourcetypesw">EnumResourceTypes</a> and <a href="/windows/win32/api/libloaderapi/nf-libloaderapi-enumresourcetypesexw">EnumResourceTypesEx</a> functions. It receives resource types. The <b>ENUMRESTYPEPROC</b> type defines a pointer to this callback function. <i>EnumResTypeProc</i> is a placeholder for the application-defined function name.

## -parameters

Expand All @@ -61,17 +61,17 @@ A handle to the module whose executable file contains the resources for which th

### -param lpType

Type: <b>LPTSTR</b>
Type: <b>LPWSTR</b>

The type of resource for which the type is being enumerated.

Alternately, rather than a pointer, this parameter can be <a href="/windows/win32/api/winuser/nf-winuser-makeintresourcea">MAKEINTRESOURCE</a>(ID), where ID is the integer identifier of the given resource type. For standard resource types, see <a href="/windows/desktop/menurc/resource-types">Resource Types</a>. For more information, see the Remarks section below.
Alternately, rather than a pointer, this parameter can be <a href="/windows/win32/api/winuser/nf-winuser-makeintresourcew">MAKEINTRESOURCE</a>(ID), where ID is the integer identifier of the given resource type. For standard resource types, see <a href="/windows/desktop/menurc/resource-types">Resource Types</a>. For more information, see the Remarks section below.

### -param lParam [in]

Type: <b>LONG_PTR</b>

An application-defined parameter passed to the <a href="/windows/win32/api/winbase/nf-winbase-enumresourcetypesa">EnumResourceTypes</a> or <a href="/windows/win32/api/libloaderapi/nf-libloaderapi-enumresourcetypesexa">EnumResourceTypesEx</a> function. This parameter can be used in error checking.
An application-defined parameter passed to the <a href="/windows/win32/api/winbase/nf-winbase-enumresourcetypesw">EnumResourceTypes</a> or <a href="/windows/win32/api/libloaderapi/nf-libloaderapi-enumresourcetypesexw">EnumResourceTypesEx</a> function. This parameter can be used in error checking.

## -returns

Expand All @@ -83,9 +83,9 @@ Returns <b>TRUE</b> to continue enumeration or <b>FALSE</b> to stop enumeration.

If <a href="/windows/win32/api/winuser/nf-winuser-is_intresource">IS_INTRESOURCE</a>(<i>lpszType</i>) is <b>TRUE</b>, then <i>lpszType</i> specifies the integer identifier of the given resource type. Otherwise, it is a pointer to a null-terminated string. If the first character of the string is a pound sign (#), then the remaining characters represent a decimal number that specifies the integer identifier of the resource type. For example, the string "#258" represents the identifier 258.

An application must register this function by passing its address to the <a href="/windows/win32/api/winbase/nf-winbase-enumresourcetypesa">EnumResourceTypes</a> or <a href="/windows/win32/api/libloaderapi/nf-libloaderapi-enumresourcetypesexa">EnumResourceTypesEx</a> function.
An application must register this function by passing its address to the <a href="/windows/win32/api/winbase/nf-winbase-enumresourcetypesw">EnumResourceTypes</a> or <a href="/windows/win32/api/libloaderapi/nf-libloaderapi-enumresourcetypesexw">EnumResourceTypesEx</a> function.

If the callback function returns <b>FALSE</b>, then <a href="/windows/win32/api/winbase/nf-winbase-enumresourcetypesa">EnumResourceTypes</a> or <a href="/windows/win32/api/libloaderapi/nf-libloaderapi-enumresourcetypesexa">EnumResourceTypesEx</a> will stop enumeration and return <b>FALSE</b>. On Windows XP and earlier the value obtained from <a href="/windows/desktop/api/errhandlingapi/nf-errhandlingapi-getlasterror">GetLastError</a> will be <b>ERROR_SUCCESS</b>; starting with Windows Vista, the last error value will be <b>ERROR_RESOURCE_ENUM_USER_STOP</b>.
If the callback function returns <b>FALSE</b>, then <a href="/windows/win32/api/winbase/nf-winbase-enumresourcetypesw">EnumResourceTypes</a> or <a href="/windows/win32/api/libloaderapi/nf-libloaderapi-enumresourcetypesexw">EnumResourceTypesEx</a> will stop enumeration and return <b>FALSE</b>. On Windows XP and earlier the value obtained from <a href="/windows/desktop/api/errhandlingapi/nf-errhandlingapi-getlasterror">GetLastError</a> will be <b>ERROR_SUCCESS</b>; starting with Windows Vista, the last error value will be <b>ERROR_RESOURCE_ENUM_USER_STOP</b>.

> [!NOTE]
> The libloaderapi.h header defines ENUMRESTYPEPROC as an alias that automatically selects the ANSI or Unicode version of this function based on the definition of the UNICODE preprocessor constant. Mixing usage of the encoding-neutral alias with code that is not encoding-neutral can lead to mismatches that result in compilation or runtime errors. For more information, see [Conventions for Function Prototypes](/windows/win32/intl/conventions-for-function-prototypes).
Expand All @@ -95,21 +95,16 @@ If the callback function returns <b>FALSE</b>, then <a href="/windows/win32/api/
<b>Conceptual</b>


<a href="/windows/win32/api/winbase/nf-winbase-enumresourcetypesw">EnumResourceTypes</a>

<a href="/windows/win32/api/winbase/nf-winbase-enumresourcetypesa">EnumResourceTypes</a>



<a href="/windows/win32/api/libloaderapi/nf-libloaderapi-enumresourcetypesexa">EnumResourceTypesEx</a>

<a href="/windows/win32/api/libloaderapi/nf-libloaderapi-enumresourcetypesexw">EnumResourceTypesEx</a>


<a href="/windows/win32/api/winuser/nf-winuser-is_intresource">IS_INTRESOURCE</a>



<b>Reference</b>



<a href="https://msdn.microsoft.com/ff321356-c999-4021-a537-fbe863996e24">Resources</a>
<a href="/windows/desktop/menurc/resources">Menus and Other Resources</a>
10 changes: 5 additions & 5 deletions sdk-api-src/content/libloaderapi/nf-libloaderapi-enumresourcelanguagesexa.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -77,15 +77,15 @@ If this parameter is <b>NULL</b>, it is equivalent to passing in a handle to the

### -param lpType [in]

Type: <b>LPCTSTR</b>
Type: <b>LPCSTR</b>

The type of the resource for which the language is being enumerated. Alternately, rather than a pointer, this parameter can be <a href="/windows/win32/api/winuser/nf-winuser-makeintresourcea">MAKEINTRESOURCE</a>(ID), where ID is an integer value representing a predefined resource type. For a list of predefined resource types, see <a href="/windows/desktop/menurc/resource-types">Resource Types</a>. For more

information, see the Remarks section below.

### -param lpName [in]

Type: <b>LPCTSTR</b>
Type: <b>LPCSTR</b>

The name of the resource for which the language is being enumerated. Alternately, rather than a pointer, this parameter can be <a href="/windows/win32/api/winuser/nf-winuser-makeintresourcea">MAKEINTRESOURCE</a>(ID), where ID is the integer identifier of the resource. For more information, see the Remarks section below.

Expand Down Expand Up @@ -168,7 +168,7 @@ The localization language used to filter the search in the .mui file. This param

Type: <b>BOOL</b>

Returns <b>TRUE</b> if the function succeeds or <b>FALSE</b> if the function does not find a resource of the type specified, or if the function fails for another reason. To get extended error information, call <a href="/windows/desktop/api/errhandlingapi/nf-errhandlingapi-getlasterror">GetLastError</a>.
Returns <b>TRUE</b> if the function succeeds or <b>FALSE</b> if the function does not find a resource of the type specified, if the enumeration has been stopped, or if the function fails for another reason. To get extended error information, call <a href="/windows/desktop/api/errhandlingapi/nf-errhandlingapi-getlasterror">GetLastError</a>.

## -remarks

Expand All @@ -190,7 +190,7 @@ The <b>EnumResourceLanguagesEx</b> function continues to enumerate resource lang

If <i>hModule</i> specifies an LN file, and both flags are selected, the languages enumerated include all languages whose resources reside either in the LN file or in any .mui files associated with it. If no .mui files are found, only languages from the LN file are returned.

If <i>dwFlags</i> contains <b>RESOURCE_ENUM_MUI</b> or <b>NULL</b> and <i>LangId</i> is 0, then the enumeration first includes the languages associated with all system-installed .mui files, using languages retrieved from <a href="/windows/desktop/api/winnls/nf-winnls-enumuilanguagesa">EnumUILanguages</a>.. Finally, if the <b>RESOURCE_ENUM_LN</b> flag is also set, the file designated by <i>hModule</i> is also searched.
If <i>dwFlags</i> contains <b>RESOURCE_ENUM_MUI</b> or <b>NULL</b> and <i>LangId</i> is 0, then the enumeration first includes the languages associated with all system-installed .mui files, using languages retrieved from <a href="/windows/desktop/api/winnls/nf-winnls-enumuilanguagesa">EnumUILanguages</a>. Finally, if the <b>RESOURCE_ENUM_LN</b> flag is also set, the file designated by <i>hModule</i> is also searched.

If the <i>LangId</i> is nonzero, then only the .mui file corresponding to that language identifier will be searched. Language fallbacks will not be used. If an .mui file for that language does not exist, the enumeration will be empty (unless resources for that language exist in the LN file, and the flag is set to search the LN file as well).

Expand Down Expand Up @@ -234,4 +234,4 @@ For an example, see <a href="/windows-hardware/drivers/wdf/creating-a-resource-r



<a href="https://msdn.microsoft.com/ff321356-c999-4021-a537-fbe863996e24">Resources</a>
<a href="/windows/desktop/menurc/resources">Menus and Other Resources</a>
Loading