SHEnumValue function
Applies to: desktop apps only
Enumerates the values of the specified open registry key.
Syntax
LSTATUS SHEnumValue( __in HKEY hkey, __in DWORD dwIndex, LPTSTR pszValueName, __inout_opt LPDWORD pcchValueName, __out_opt LPDWORD pdwType, LPVOID pvData, __inout_opt LPDWORD pcbData );
Parameters
- hkey [in]
-
Type: HKEY
A handle to the currently open key, or any of the following predefined values.
- dwIndex [in]
-
Type: DWORD
The index of the value to retrieve. This parameter should be zero for the first call and incremented for subsequent calls.
- pszValueName
-
Type: LPTSTR
The address of a character buffer that receives the enumerated value name. The size of this buffer is specified in pcchValueName.
- pcchValueName [in, out, optional]
-
Type: LPDWORD
The address of a DWORD that, on entry, contains the size of the buffer at pszValueName, in characters. On exit, this contains the number of characters that were copied to pszValueName.
- pdwType [out, optional]
-
Type: LPDWORD
The address of a DWORD that receives the data type of the value. These are the same values as those described under the lpType parameter of RegEnumValue.
- pvData
-
Type: LPVOID
The address of a buffer that receives the data for the value entry. The size of this buffer is specified in pcbData. This parameter can be NULL if the data is not required.
- pcbData [in, out, optional]
-
Type: LPDWORD
The address of a DWORD that, on entry, contains the size of the buffer at pvData, in bytes. On exit, this contains the number of bytes that were copied to pvData.
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 | SHEnumValueW (Unicode) and SHEnumValueA (ANSI) |
Send comments about this topic to Microsoft
Build date: 3/7/2012
