Edit

Share via

SHEnumValueA function (shlwapi.h)

  • Article

Enumerates the values of the specified open registry key.

Syntax

LSTATUS SHEnumValueA(
  [in]                HKEY    hkey,
  [in]                DWORD   dwIndex,
                      PSTR    pszValueName,
  [in, out, optional] LPDWORD pcchValueName,
  [out, optional]     LPDWORD pdwType,
                      void    *pvData,
  [in, out, optional] LPDWORD pcbData
);

Parameters

[in] hkey

Type: HKEY

A handle to the currently open key, or any of the following predefined values.

HKEY_CLASSES_ROOT

HKEY_CURRENT_CONFIG

HKEY_CURRENT_USER

HKEY_LOCAL_MACHINE

HKEY_PERFORMANCE_DATA

HKEY_USERS

[in] dwIndex

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.

[in, out, optional] pcchValueName

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.

[out, optional] pdwType

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.

[in, out, optional] pcbData

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.

Remarks

Note

The shlwapi.h header defines SHEnumValue as an alias which 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 not encoding-neutral can lead to mismatches that result in compilation or runtime errors. For more information, see Conventions for Function Prototypes.

Requirements

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)