SHQueryInfoKey function
Applies to: desktop apps only
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.
- 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 |
|---|---|
|
Minimum supported server | Windows 2000 Server |
|
Header |
|
|
Library |
|
|
DLL |
|
|
Unicode and ANSI names | SHQueryInfoKeyW (Unicode) and SHQueryInfoKeyA (ANSI) |
Send comments about this topic to Microsoft
Build date: 3/7/2012
