ホーム › System.Registry › RegQueryInfoKeyA

RegQueryInfoKeyA

関数

指定キーのサブキー数や値数などの情報を取得する。

DLLADVAPI32.dll文字セットANSI (-A)呼出規約winapi対応OSWindows 2000 以降

シグネチャ

// ADVAPI32.dll  (ANSI / -A)
#include <windows.h>

WIN32_ERROR RegQueryInfoKeyA(
    HKEY hKey,
    LPSTR lpClass,   // optional
    DWORD* lpcchClass,   // optional
    DWORD* lpReserved,   // optional
    DWORD* lpcSubKeys,   // optional
    DWORD* lpcbMaxSubKeyLen,   // optional
    DWORD* lpcbMaxClassLen,   // optional
    DWORD* lpcValues,   // optional
    DWORD* lpcbMaxValueNameLen,   // optional
    DWORD* lpcbMaxValueLen,   // optional
    DWORD* lpcbSecurityDescriptor,   // optional
    FILETIME* lpftLastWriteTime   // optional
);

パラメーター

名前	型	方向	説明
hKey	HKEY	in	開いているレジストリキーへのハンドル。このキーは KEY_QUERY_VALUE アクセス権で開かれている必要があります。詳細については、 Registry Key Security and Access Rights を参照してください。このハンドルは、 RegCreateKeyEx、RegCreateKeyTransacted、RegOpenKeyEx、または RegOpenKeyTransacted 関数によって返されます。また、次の定義済みキーのいずれかを指定することもできます: HKEY_CLASSES_ROOT HKEY_CURRENT_CONFIG HKEY_CURRENT_USER HKEY_LOCAL_MACHINE HKEY_PERFORMANCE_DATA HKEY_USERS
lpClass	LPSTR	outoptional	キーのユーザー定義クラスを受け取るバッファーへのポインター。このパラメーターは NULL にすることができます。
lpcchClass	DWORD*	inoutoptional	lpClass パラメーターが指すバッファーのサイズを文字単位で指定する変数へのポインター。このサイズには終端の null 文字を含める必要があります。関数が返るとき、この変数にはバッファーに格納されたクラス文字列のサイズが格納されます。返されるカウントには終端の null 文字は含まれません。バッファーが十分に大きくない場合、関数は ERROR_MORE_DATA を返し、この変数には終端の null 文字を含まない文字列のサイズ(文字単位)が格納されます。 lpClass が NULL の場合、lpcClass も NULL にすることができます。 lpClass パラメーターが有効なアドレスであるのに lpcClass パラメーターが有効でない場合(たとえば NULL の場合)、関数は ERROR_INVALID_PARAMETER を返します。
lpReserved	DWORD*	optional	このパラメーターは予約されており、NULL である必要があります。
lpcSubKeys	DWORD*	outoptional	指定したキーに含まれるサブキーの数を受け取る変数へのポインター。このパラメーターは NULL にすることができます。
lpcbMaxSubKeyLen	DWORD*	outoptional	キーのサブキーのうち名前が最も長いもののサイズを、終端の null 文字を含めずに ANSI 文字単位で受け取る変数へのポインター。このパラメーターは NULL にすることができます。
lpcbMaxClassLen	DWORD*	outoptional	サブキーのクラスを指定する文字列のうち最も長いもののサイズを ANSI 文字単位で受け取る変数へのポインター。返されるカウントには終端の null 文字は含まれません。このパラメーターは NULL にすることができます。
lpcValues	DWORD*	outoptional	キーに関連付けられた値の数を受け取る変数へのポインター。このパラメーターは NULL にすることができます。
lpcbMaxValueNameLen	DWORD*	outoptional	キーの値名のうち最も長いもののサイズを ANSI 文字単位で受け取る変数へのポインター。このサイズには終端の null 文字は含まれません。このパラメーターは NULL にすることができます。
lpcbMaxValueLen	DWORD*	outoptional	キーの値のうち最も長いデータコンポーネントのサイズをバイト単位で受け取る変数へのポインター。このパラメーターは NULL にすることができます。
lpcbSecurityDescriptor	DWORD*	outoptional	キーのセキュリティ記述子のサイズをバイト単位で受け取る変数へのポインター。このパラメーターは NULL にすることができます。
lpftLastWriteTime	FILETIME*	outoptional	最終書き込み時刻を受け取る FILETIME 構造体へのポインター。このパラメーターは NULL にすることができます。関数は、キーまたはその値エントリのいずれかが最後に変更された時刻を示すように、 FILETIME 構造体のメンバーを設定します。

戻り値の型: WIN32_ERROR

公式ドキュメント

指定したレジストリキーに関する情報を取得します。(ANSI)

戻り値

関数が成功した場合、戻り値は ERROR_SUCCESS です。

関数が失敗した場合、戻り値はシステムエラーコードです。

lpClass バッファーがクラス名を受け取るには小さすぎる場合、関数は ERROR_MORE_DATA を返します。

解説(Remarks)

メモ

以前のバージョンの Windows では、この API は kernel32.dll でも公開されています。

出典・ライセンス: 上記「公式ドキュメント」の内容は Microsoft の Win32 API ドキュメント(MicrosoftDocs/sdk-api)を日本語に翻訳・改変したものです。© Microsoft Corporation. CC BY 4.0 で提供。
Microsoft 公式リファレンス: 英語 (en-us) · 日本語 (ja-jp) · 原文ソース (GitHub)

各言語での呼び出し定義

// ADVAPI32.dll  (ANSI / -A)
#include <windows.h>

WIN32_ERROR RegQueryInfoKeyA(
    HKEY hKey,
    LPSTR lpClass,   // optional
    DWORD* lpcchClass,   // optional
    DWORD* lpReserved,   // optional
    DWORD* lpcSubKeys,   // optional
    DWORD* lpcbMaxSubKeyLen,   // optional
    DWORD* lpcbMaxClassLen,   // optional
    DWORD* lpcValues,   // optional
    DWORD* lpcbMaxValueNameLen,   // optional
    DWORD* lpcbMaxValueLen,   // optional
    DWORD* lpcbSecurityDescriptor,   // optional
    FILETIME* lpftLastWriteTime   // optional
);

[DllImport("ADVAPI32.dll", CharSet = CharSet.Ansi, ExactSpelling = true)]
static extern uint RegQueryInfoKeyA(
    IntPtr hKey,   // HKEY
    [MarshalAs(UnmanagedType.LPStr)] System.Text.StringBuilder lpClass,   // LPSTR optional, out
    IntPtr lpcchClass,   // DWORD* optional, in/out
    IntPtr lpReserved,   // DWORD* optional
    IntPtr lpcSubKeys,   // DWORD* optional, out
    IntPtr lpcbMaxSubKeyLen,   // DWORD* optional, out
    IntPtr lpcbMaxClassLen,   // DWORD* optional, out
    IntPtr lpcValues,   // DWORD* optional, out
    IntPtr lpcbMaxValueNameLen,   // DWORD* optional, out
    IntPtr lpcbMaxValueLen,   // DWORD* optional, out
    IntPtr lpcbSecurityDescriptor,   // DWORD* optional, out
    IntPtr lpftLastWriteTime   // FILETIME* optional, out
);

<DllImport("ADVAPI32.dll", CharSet:=CharSet.Ansi, ExactSpelling:=True)>
Public Shared Function RegQueryInfoKeyA(
    hKey As IntPtr,   ' HKEY
    <MarshalAs(UnmanagedType.LPStr)> lpClass As System.Text.StringBuilder,   ' LPSTR optional, out
    lpcchClass As IntPtr,   ' DWORD* optional, in/out
    lpReserved As IntPtr,   ' DWORD* optional
    lpcSubKeys As IntPtr,   ' DWORD* optional, out
    lpcbMaxSubKeyLen As IntPtr,   ' DWORD* optional, out
    lpcbMaxClassLen As IntPtr,   ' DWORD* optional, out
    lpcValues As IntPtr,   ' DWORD* optional, out
    lpcbMaxValueNameLen As IntPtr,   ' DWORD* optional, out
    lpcbMaxValueLen As IntPtr,   ' DWORD* optional, out
    lpcbSecurityDescriptor As IntPtr,   ' DWORD* optional, out
    lpftLastWriteTime As IntPtr   ' FILETIME* optional, out
) As UInteger
End Function

' hKey : HKEY
' lpClass : LPSTR optional, out
' lpcchClass : DWORD* optional, in/out
' lpReserved : DWORD* optional
' lpcSubKeys : DWORD* optional, out
' lpcbMaxSubKeyLen : DWORD* optional, out
' lpcbMaxClassLen : DWORD* optional, out
' lpcValues : DWORD* optional, out
' lpcbMaxValueNameLen : DWORD* optional, out
' lpcbMaxValueLen : DWORD* optional, out
' lpcbSecurityDescriptor : DWORD* optional, out
' lpftLastWriteTime : FILETIME* optional, out
Declare PtrSafe Function RegQueryInfoKeyA Lib "advapi32" ( _
    ByVal hKey As LongPtr, _
    ByVal lpClass As String, _
    ByVal lpcchClass As LongPtr, _
    ByVal lpReserved As LongPtr, _
    ByVal lpcSubKeys As LongPtr, _
    ByVal lpcbMaxSubKeyLen As LongPtr, _
    ByVal lpcbMaxClassLen As LongPtr, _
    ByVal lpcValues As LongPtr, _
    ByVal lpcbMaxValueNameLen As LongPtr, _
    ByVal lpcbMaxValueLen As LongPtr, _
    ByVal lpcbSecurityDescriptor As LongPtr, _
    ByVal lpftLastWriteTime As LongPtr) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。

import ctypes
from ctypes import wintypes

RegQueryInfoKeyA = ctypes.windll.advapi32.RegQueryInfoKeyA
RegQueryInfoKeyA.restype = wintypes.DWORD
RegQueryInfoKeyA.argtypes = [
    wintypes.HANDLE,  # hKey : HKEY
    wintypes.LPSTR,  # lpClass : LPSTR optional, out
    ctypes.POINTER(wintypes.DWORD),  # lpcchClass : DWORD* optional, in/out
    ctypes.POINTER(wintypes.DWORD),  # lpReserved : DWORD* optional
    ctypes.POINTER(wintypes.DWORD),  # lpcSubKeys : DWORD* optional, out
    ctypes.POINTER(wintypes.DWORD),  # lpcbMaxSubKeyLen : DWORD* optional, out
    ctypes.POINTER(wintypes.DWORD),  # lpcbMaxClassLen : DWORD* optional, out
    ctypes.POINTER(wintypes.DWORD),  # lpcValues : DWORD* optional, out
    ctypes.POINTER(wintypes.DWORD),  # lpcbMaxValueNameLen : DWORD* optional, out
    ctypes.POINTER(wintypes.DWORD),  # lpcbMaxValueLen : DWORD* optional, out
    ctypes.POINTER(wintypes.DWORD),  # lpcbSecurityDescriptor : DWORD* optional, out
    ctypes.c_void_p,  # lpftLastWriteTime : FILETIME* optional, out
]

require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('ADVAPI32.dll')
RegQueryInfoKeyA = Fiddle::Function.new(
  lib['RegQueryInfoKeyA'],
  [
    Fiddle::TYPE_VOIDP,  # hKey : HKEY
    Fiddle::TYPE_VOIDP,  # lpClass : LPSTR optional, out
    Fiddle::TYPE_VOIDP,  # lpcchClass : DWORD* optional, in/out
    Fiddle::TYPE_VOIDP,  # lpReserved : DWORD* optional
    Fiddle::TYPE_VOIDP,  # lpcSubKeys : DWORD* optional, out
    Fiddle::TYPE_VOIDP,  # lpcbMaxSubKeyLen : DWORD* optional, out
    Fiddle::TYPE_VOIDP,  # lpcbMaxClassLen : DWORD* optional, out
    Fiddle::TYPE_VOIDP,  # lpcValues : DWORD* optional, out
    Fiddle::TYPE_VOIDP,  # lpcbMaxValueNameLen : DWORD* optional, out
    Fiddle::TYPE_VOIDP,  # lpcbMaxValueLen : DWORD* optional, out
    Fiddle::TYPE_VOIDP,  # lpcbSecurityDescriptor : DWORD* optional, out
    Fiddle::TYPE_VOIDP,  # lpftLastWriteTime : FILETIME* optional, out
  ],
  -Fiddle::TYPE_INT)

#[link(name = "advapi32")]
extern "system" {
    fn RegQueryInfoKeyA(
        hKey: *mut core::ffi::c_void,  // HKEY
        lpClass: *mut u8,  // LPSTR optional, out
        lpcchClass: *mut u32,  // DWORD* optional, in/out
        lpReserved: *mut u32,  // DWORD* optional
        lpcSubKeys: *mut u32,  // DWORD* optional, out
        lpcbMaxSubKeyLen: *mut u32,  // DWORD* optional, out
        lpcbMaxClassLen: *mut u32,  // DWORD* optional, out
        lpcValues: *mut u32,  // DWORD* optional, out
        lpcbMaxValueNameLen: *mut u32,  // DWORD* optional, out
        lpcbMaxValueLen: *mut u32,  // DWORD* optional, out
        lpcbSecurityDescriptor: *mut u32,  // DWORD* optional, out
        lpftLastWriteTime: *mut FILETIME  // FILETIME* optional, out
    ) -> u32;
}
// crates: windows-sys provides ready-made bindings for this API.

$sig = @"
[DllImport("ADVAPI32.dll", CharSet = CharSet.Ansi)]
public static extern uint RegQueryInfoKeyA(IntPtr hKey, [MarshalAs(UnmanagedType.LPStr)] System.Text.StringBuilder lpClass, IntPtr lpcchClass, IntPtr lpReserved, IntPtr lpcSubKeys, IntPtr lpcbMaxSubKeyLen, IntPtr lpcbMaxClassLen, IntPtr lpcValues, IntPtr lpcbMaxValueNameLen, IntPtr lpcbMaxValueLen, IntPtr lpcbSecurityDescriptor, IntPtr lpftLastWriteTime);
"@
$api = Add-Type -MemberDefinition $sig -Name 'ADVAPI32_RegQueryInfoKeyA' -Namespace Win32 -PassThru
# $api::RegQueryInfoKeyA(hKey, lpClass, lpcchClass, lpReserved, lpcSubKeys, lpcbMaxSubKeyLen, lpcbMaxClassLen, lpcValues, lpcbMaxValueNameLen, lpcbMaxValueLen, lpcbSecurityDescriptor, lpftLastWriteTime)

#uselib "ADVAPI32.dll"
#func global RegQueryInfoKeyA "RegQueryInfoKeyA" sptr, sptr, sptr, sptr, sptr, sptr, sptr, sptr, sptr, sptr, sptr, sptr
; RegQueryInfoKeyA hKey, varptr(lpClass), varptr(lpcchClass), varptr(lpReserved), varptr(lpcSubKeys), varptr(lpcbMaxSubKeyLen), varptr(lpcbMaxClassLen), varptr(lpcValues), varptr(lpcbMaxValueNameLen), varptr(lpcbMaxValueLen), varptr(lpcbSecurityDescriptor), varptr(lpftLastWriteTime)   ; 戻り値は stat
; hKey : HKEY -> "sptr"
; lpClass : LPSTR optional, out -> "sptr"
; lpcchClass : DWORD* optional, in/out -> "sptr"
; lpReserved : DWORD* optional -> "sptr"
; lpcSubKeys : DWORD* optional, out -> "sptr"
; lpcbMaxSubKeyLen : DWORD* optional, out -> "sptr"
; lpcbMaxClassLen : DWORD* optional, out -> "sptr"
; lpcValues : DWORD* optional, out -> "sptr"
; lpcbMaxValueNameLen : DWORD* optional, out -> "sptr"
; lpcbMaxValueLen : DWORD* optional, out -> "sptr"
; lpcbSecurityDescriptor : DWORD* optional, out -> "sptr"
; lpftLastWriteTime : FILETIME* optional, out -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。

出力引数:

#uselib "ADVAPI32.dll"
#cfunc global RegQueryInfoKeyA "RegQueryInfoKeyA" sptr, var, var, var, var, var, var, var, var, var, var, var
; res = RegQueryInfoKeyA(hKey, lpClass, lpcchClass, lpReserved, lpcSubKeys, lpcbMaxSubKeyLen, lpcbMaxClassLen, lpcValues, lpcbMaxValueNameLen, lpcbMaxValueLen, lpcbSecurityDescriptor, lpftLastWriteTime)
; hKey : HKEY -> "sptr"
; lpClass : LPSTR optional, out -> "var"
; lpcchClass : DWORD* optional, in/out -> "var"
; lpReserved : DWORD* optional -> "var"
; lpcSubKeys : DWORD* optional, out -> "var"
; lpcbMaxSubKeyLen : DWORD* optional, out -> "var"
; lpcbMaxClassLen : DWORD* optional, out -> "var"
; lpcValues : DWORD* optional, out -> "var"
; lpcbMaxValueNameLen : DWORD* optional, out -> "var"
; lpcbMaxValueLen : DWORD* optional, out -> "var"
; lpcbSecurityDescriptor : DWORD* optional, out -> "var"
; lpftLastWriteTime : FILETIME* optional, out -> "var"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。#uselib "ADVAPI32.dll"
#cfunc global RegQueryInfoKeyA "RegQueryInfoKeyA" sptr, sptr, sptr, sptr, sptr, sptr, sptr, sptr, sptr, sptr, sptr, sptr
; res = RegQueryInfoKeyA(hKey, varptr(lpClass), varptr(lpcchClass), varptr(lpReserved), varptr(lpcSubKeys), varptr(lpcbMaxSubKeyLen), varptr(lpcbMaxClassLen), varptr(lpcValues), varptr(lpcbMaxValueNameLen), varptr(lpcbMaxValueLen), varptr(lpcbSecurityDescriptor), varptr(lpftLastWriteTime))
; hKey : HKEY -> "sptr"
; lpClass : LPSTR optional, out -> "sptr"
; lpcchClass : DWORD* optional, in/out -> "sptr"
; lpReserved : DWORD* optional -> "sptr"
; lpcSubKeys : DWORD* optional, out -> "sptr"
; lpcbMaxSubKeyLen : DWORD* optional, out -> "sptr"
; lpcbMaxClassLen : DWORD* optional, out -> "sptr"
; lpcValues : DWORD* optional, out -> "sptr"
; lpcbMaxValueNameLen : DWORD* optional, out -> "sptr"
; lpcbMaxValueLen : DWORD* optional, out -> "sptr"
; lpcbSecurityDescriptor : DWORD* optional, out -> "sptr"
; lpftLastWriteTime : FILETIME* optional, out -> "sptr"
; ※出力/バッファ引数はポインタ方式(token=sptr / 呼び出しは varptr(変数))。