SHRegEnumUSValue function
Applies to: desktop apps only
Enumerates the values of the specified registry subkey in a user-specific subtree (HKEY_CURRENT_USER or HKEY_LOCAL_MACHINE).
Syntax
LSTATUS SHRegEnumUSValue( __in HUSKEY hUSKey, __in DWORD dwIndex, __out LPTSTR pszValueName, __inout LPDWORD pcchValueNameLen, __out_opt LPDWORD pdwType, __out_opt void *pvData, __inout_opt LPDWORD pcbData, __in SHREGENUM_FLAGS enumRegFlags );
Parameters
- hUSKey [in]
-
Type: HUSKEY
A handle to a currently open registry subkey. The subkey must have been opened with the KEY_SET_VALUE access right. For more information, see Registry Key Security and Access Rights.
This handle can be obtained through the SHRegOpenUSKey function.
- 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 [out]
-
Type: LPTSTR
A pointer to a character buffer that receives the enumerated value name. The size of this buffer is specified in pcchValueNameLen.
- pcchValueNameLen [in, out]
-
Type: LPDWORD
A pointer to 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
A pointer to 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 [out, optional]
-
Type: void*
A pointer to 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
A pointer to a DWORD that, on entry, contains the size of the buffer at pvData. On exit, this contains the number of bytes that were copied to pvData.
- enumRegFlags [in]
-
Type: SHREGENUM_FLAGS
One of the SHREGENUM_FLAGS that specifies the base key in which the enumeration should take place.
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 | SHRegEnumUSValueW (Unicode) and SHRegEnumUSValueA (ANSI) |
Send comments about this topic to Microsoft
Build date: 3/7/2012
