SHRegQueryInfoUSKeyA function (shlwapi.h)

  • Article

Retrieves information about a specified registry subkey in a user-specific subtree (HKEY_CURRENT_USER or HKEY_LOCAL_MACHINE).

Syntax

LSTATUS SHRegQueryInfoUSKeyA(
  [in]            HUSKEY          hUSKey,
  [out, optional] LPDWORD         pcSubKeys,
  [out, optional] LPDWORD         pcchMaxSubKeyLen,
  [out, optional] LPDWORD         pcValues,
  [out, optional] LPDWORD         pcchMaxValueNameLen,
  [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.

[out, optional] pcSubKeys

Type: LPDWORD

A pointer to a DWORD that receives the number of subkeys under the specified key.

[out, optional] pcchMaxSubKeyLen

Type: LPDWORD

A pointer to a DWORD that receives the number of characters in the largest subkey name.

[out, optional] pcValues

Type: LPDWORD

A pointer to a DWORD that receives the number of values under the specified key.

[out, optional] pcchMaxValueNameLen

Type: LPDWORD

A pointer to a DWORD that receives the number of characters in the largest value name.

[in] enumRegFlags

Type: SHREGENUM_FLAGS

One of the SHREGENUM_FLAGS that specifies the base key in which the query 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 SHRegQueryInfoUSKey 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)