This topic has not yet been rated - Rate this topic

SHRegQueryInfoUSKey function

Applies to: desktop apps only

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

Syntax

LSTATUS SHRegQueryInfoUSKey(
  __in       HUSKEY hUSKey,
  __out_opt  LPDWORD pcSubKeys,
  __out_opt  LPDWORD pcchMaxSubKeyLen,
  __out_opt  LPDWORD pcValues,
  __out_opt  LPDWORD pcchMaxValueNameLen,
  __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.

pcSubKeys [out, optional]

Type: LPDWORD

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

pcchMaxSubKeyLen [out, optional]

Type: LPDWORD

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

pcValues [out, optional]

Type: LPDWORD

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

pcchMaxValueNameLen [out, optional]

Type: LPDWORD

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

enumRegFlags [in]

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.

Requirements

Minimum supported client

Windows 2000 Professional, Windows XP

Minimum supported server

Windows 2000 Server

Header

Shlwapi.h

Library

Shlwapi.lib

DLL

Shlwapi.dll (version 4.71 or later)

Unicode and ANSI names

SHRegQueryInfoUSKeyW (Unicode) and SHRegQueryInfoUSKeyA (ANSI)

 

 

Send comments about this topic to Microsoft

Build date: 3/7/2012

Did you find this helpful?
(1500 characters remaining)
Community Content Add
Annotations FAQ