SHRegEnumUSKeyW function (shlwapi.h)

Article
02/22/2024

Enumerates the subkeys of a registry subkey in a user-specific subtree (HKEY_CURRENT_USER or HKEY_LOCAL_MACHINE).

Syntax

LSTATUS SHRegEnumUSKeyW(
  [in]      HUSKEY          hUSKey,
  [in]      DWORD           dwIndex,
            LPWSTR          pwzName,
  [in, out] LPDWORD         pcchName,
  [in]      SHREGENUM_FLAGS enumRegFlags
);

Parameters

[in] hUSKey

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.

[in] dwIndex

Type: DWORD

The index of the subkey to retrieve. This parameter should be zero for the first call and incremented for subsequent calls.

pwzName

TBD

[in, out] pcchName

Type: LPDWORD

A pointer to 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.

[in] enumRegFlags

Type: SHREGENUM_FLAGS

A 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.

Remarks

Note

The shlwapi.h header defines SHRegEnumUSKey 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)

Share via