SHEnumKeyExW function (shlwapi.h)
Enumerates the subkeys of the specified open registry key.
LSTATUS SHEnumKeyExW(
[in] HKEY hkey,
DWORD dwIndex,
LPWSTR pszName,
[in] LPDWORD pcchName
);
[in] hkey
Type: HKEY
A handle to the currently open key, or any of the following predefined values.
dwIndex
Type: DWORD
The index of the subkey to retrieve. This parameter should be zero for the first call and incremented for subsequent calls.
pszName
Type: LPTSTR
The address of a character buffer that receives the enumerated key name.
[in] pcchName
Type: LPDWORD
The address of a DWORD that, on entry, contains the size of the buffer at pszName, in characters. On exit, this contains the number of characters that were copied to pszName.
Type: LSTATUS
Returns ERROR_SUCCESS if successful, or a nonzero error code defined in Winerror.h otherwise. You can use the FormatMessage function with the FORMAT_MESSAGE_FROM_SYSTEM flag to retrieve a textual description of the error.
Note
The shlwapi.h header defines SHEnumKeyEx 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.
Requirement | Value |
---|---|
Minimum supported client | Windows 2000 Professional, Windows XP [desktop apps only] |
Minimum supported server | Windows 2000 Server [desktop apps only] |
Target Platform | Windows |
Header | shlwapi.h |
Library | Shlwapi.lib |
DLL | Shlwapi.dll (version 4.71 or later) |