Was this page helpful?
Your feedback about this content is important. Let us know what you think.
Additional feedback?
1500 characters remaining
Export (0) Print
Expand All

SHRegEnumUSKey function

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

Syntax


LSTATUS SHRegEnumUSKey(
  _In_    HUSKEY          hUSKey,
  _In_    DWORD           dwIndex,
  _Out_   LPTSTR          pszName,
  _Inout_ LPDWORD         pcchName,
  _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 subkey to retrieve. This parameter should be zero for the first call and incremented for subsequent calls.

pszName [out]

Type: LPTSTR

A pointer to a character buffer that receives the enumerated key name.

pcchName [in, out]

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.

enumRegFlags [in]

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.

Requirements

Minimum supported client

Windows 2000 Professional, Windows XP [desktop apps only]

Minimum supported server

Windows 2000 Server [desktop apps only]

Header

Shlwapi.h

Library

Shlwapi.lib

DLL

Shlwapi.dll (version 4.71 or later)

Unicode and ANSI names

SHRegEnumUSKeyW (Unicode) and SHRegEnumUSKeyA (ANSI)

 

 

Community Additions

ADD
Show:
© 2015 Microsoft