SHEnumKeyEx function
Applies to: desktop apps only
Enumerates the subkeys of the specified open registry key.
Syntax
LSTATUS SHEnumKeyEx( __in HKEY hkey, DWORD dwIndex, LPTSTR pszName, __in LPDWORD pcchName );
Parameters
- hkey [in]
-
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.
- pcchName [in]
-
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.
Return value
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.
Requirements
|
Minimum supported client | Windows 2000 Professional, Windows XP |
|---|---|
|
Minimum supported server | Windows 2000 Server |
|
Header |
|
|
Library |
|
|
DLL |
|
|
Unicode and ANSI names | SHEnumKeyExW (Unicode) and SHEnumKeyExA (ANSI) |
Send comments about this topic to Microsoft
Build date: 3/7/2012
