Information
The topic you requested is included in another documentation set. For convenience, it's displayed below. Choose Switch to see the topic in its original location.

SHQueryInfoKey function

Retrieves information about a specified registry key.

Syntax


LSTATUS SHQueryInfoKey(
  _In_       HKEY hkey,
  _Out_opt_  LPDWORD pcSubKeys,
  _Out_opt_  LPDWORD pcchMaxSubKeyLen,
  _Out_opt_  LPDWORD pcValues,
  _Out_opt_  LPDWORD pcchMaxValueNameLen
);

Parameters

hkey [in]

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

pcSubKeys [out, optional]

Type: LPDWORD

The address of a DWORD that receives the number of subkeys under the specified key.

pcchMaxSubKeyLen [out, optional]

Type: LPDWORD

The address of a DWORD that receives the number of characters in the name of the subkey with the largest name.

pcValues [out, optional]

Type: LPDWORD

The address of a DWORD that receives the number of values under the specified key.

pcchMaxValueNameLen [out, optional]

Type: LPDWORD

The address of a DWORD that receives the number of characters in the name of the value with the largest name.

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

SHQueryInfoKeyW (Unicode) and SHQueryInfoKeyA (ANSI)

 

 

Community Additions

Show:
© 2014 Microsoft