Win32 API 日本語リファレンス
ホームUI.Shell › SHQueryInfoKeyA

SHQueryInfoKeyA

関数
レジストリキーのサブキー数や値数などの情報を取得する。
DLLSHLWAPI.dll文字セットANSI (-A)呼出規約winapi対応OSWindows 2000 以降

シグネチャ

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

WIN32_ERROR SHQueryInfoKeyA(
    HKEY hkey,
    DWORD* pcSubKeys,   // optional
    DWORD* pcchMaxSubKeyLen,   // optional
    DWORD* pcValues,   // optional
    DWORD* pcchMaxValueNameLen   // optional
);

パラメーター

名前方向説明
hkeyHKEYin

現在開いているキーへのハンドル、または次の定義済みの値のいずれか。

HKEY_CLASSES_ROOT

HKEY_CURRENT_CONFIG

HKEY_CURRENT_USER

HKEY_LOCAL_MACHINE

HKEY_PERFORMANCE_DATA

HKEY_USERS

pcSubKeysDWORD*outoptional指定されたキーの下にあるサブキーの数を受け取る DWORD のアドレス。
pcchMaxSubKeyLenDWORD*outoptional最も長い名前を持つサブキーの名前の文字数を受け取る DWORD のアドレス。
pcValuesDWORD*outoptional指定されたキーの下にある値の数を受け取る DWORD のアドレス。
pcchMaxValueNameLenDWORD*outoptional最も長い名前を持つ値の名前の文字数を受け取る DWORD のアドレス。

戻り値の型: WIN32_ERROR

公式ドキュメント

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

戻り値

型: LSTATUS

成功した場合は ERROR_SUCCESS を返し、それ以外の場合は Winerror.h で定義されている 0 以外のエラーコードを返します。FormatMessage 関数を FORMAT_MESSAGE_FROM_SYSTEM フラグとともに使用することで、エラーのテキストによる説明を取得できます。

解説(Remarks)

メモ

shlwapi.h ヘッダーは SHQueryInfoKey をエイリアスとして定義しており、UNICODE プリプロセッサ定数の定義に基づいて、この関数の ANSI 版または Unicode 版を自動的に選択します。エンコーディング中立のエイリアスの使用を、エンコーディング中立でないコードと混在させると、コンパイルエラーや実行時エラーを引き起こす不整合が生じる可能性があります。詳細については、Conventions for Function Prototypes を参照してください。

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

各言語での呼び出し定義

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

WIN32_ERROR SHQueryInfoKeyA(
    HKEY hkey,
    DWORD* pcSubKeys,   // optional
    DWORD* pcchMaxSubKeyLen,   // optional
    DWORD* pcValues,   // optional
    DWORD* pcchMaxValueNameLen   // optional
);
[DllImport("SHLWAPI.dll", CharSet = CharSet.Ansi, ExactSpelling = true)]
static extern uint SHQueryInfoKeyA(
    IntPtr hkey,   // HKEY
    IntPtr pcSubKeys,   // DWORD* optional, out
    IntPtr pcchMaxSubKeyLen,   // DWORD* optional, out
    IntPtr pcValues,   // DWORD* optional, out
    IntPtr pcchMaxValueNameLen   // DWORD* optional, out
);
<DllImport("SHLWAPI.dll", CharSet:=CharSet.Ansi, ExactSpelling:=True)>
Public Shared Function SHQueryInfoKeyA(
    hkey As IntPtr,   ' HKEY
    pcSubKeys As IntPtr,   ' DWORD* optional, out
    pcchMaxSubKeyLen As IntPtr,   ' DWORD* optional, out
    pcValues As IntPtr,   ' DWORD* optional, out
    pcchMaxValueNameLen As IntPtr   ' DWORD* optional, out
) As UInteger
End Function
' hkey : HKEY
' pcSubKeys : DWORD* optional, out
' pcchMaxSubKeyLen : DWORD* optional, out
' pcValues : DWORD* optional, out
' pcchMaxValueNameLen : DWORD* optional, out
Declare PtrSafe Function SHQueryInfoKeyA Lib "shlwapi" ( _
    ByVal hkey As LongPtr, _
    ByVal pcSubKeys As LongPtr, _
    ByVal pcchMaxSubKeyLen As LongPtr, _
    ByVal pcValues As LongPtr, _
    ByVal pcchMaxValueNameLen As LongPtr) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。
import ctypes
from ctypes import wintypes

SHQueryInfoKeyA = ctypes.windll.shlwapi.SHQueryInfoKeyA
SHQueryInfoKeyA.restype = wintypes.DWORD
SHQueryInfoKeyA.argtypes = [
    wintypes.HANDLE,  # hkey : HKEY
    ctypes.POINTER(wintypes.DWORD),  # pcSubKeys : DWORD* optional, out
    ctypes.POINTER(wintypes.DWORD),  # pcchMaxSubKeyLen : DWORD* optional, out
    ctypes.POINTER(wintypes.DWORD),  # pcValues : DWORD* optional, out
    ctypes.POINTER(wintypes.DWORD),  # pcchMaxValueNameLen : DWORD* optional, out
]
require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('SHLWAPI.dll')
SHQueryInfoKeyA = Fiddle::Function.new(
  lib['SHQueryInfoKeyA'],
  [
    Fiddle::TYPE_VOIDP,  # hkey : HKEY
    Fiddle::TYPE_VOIDP,  # pcSubKeys : DWORD* optional, out
    Fiddle::TYPE_VOIDP,  # pcchMaxSubKeyLen : DWORD* optional, out
    Fiddle::TYPE_VOIDP,  # pcValues : DWORD* optional, out
    Fiddle::TYPE_VOIDP,  # pcchMaxValueNameLen : DWORD* optional, out
  ],
  -Fiddle::TYPE_INT)
#[link(name = "shlwapi")]
extern "system" {
    fn SHQueryInfoKeyA(
        hkey: *mut core::ffi::c_void,  // HKEY
        pcSubKeys: *mut u32,  // DWORD* optional, out
        pcchMaxSubKeyLen: *mut u32,  // DWORD* optional, out
        pcValues: *mut u32,  // DWORD* optional, out
        pcchMaxValueNameLen: *mut u32  // DWORD* optional, out
    ) -> u32;
}
// crates: windows-sys provides ready-made bindings for this API.
$sig = @"
[DllImport("SHLWAPI.dll", CharSet = CharSet.Ansi)]
public static extern uint SHQueryInfoKeyA(IntPtr hkey, IntPtr pcSubKeys, IntPtr pcchMaxSubKeyLen, IntPtr pcValues, IntPtr pcchMaxValueNameLen);
"@
$api = Add-Type -MemberDefinition $sig -Name 'SHLWAPI_SHQueryInfoKeyA' -Namespace Win32 -PassThru
# $api::SHQueryInfoKeyA(hkey, pcSubKeys, pcchMaxSubKeyLen, pcValues, pcchMaxValueNameLen)
#uselib "SHLWAPI.dll"
#func global SHQueryInfoKeyA "SHQueryInfoKeyA" sptr, sptr, sptr, sptr, sptr
; SHQueryInfoKeyA hkey, varptr(pcSubKeys), varptr(pcchMaxSubKeyLen), varptr(pcValues), varptr(pcchMaxValueNameLen)   ; 戻り値は stat
; hkey : HKEY -> "sptr"
; pcSubKeys : DWORD* optional, out -> "sptr"
; pcchMaxSubKeyLen : DWORD* optional, out -> "sptr"
; pcValues : DWORD* optional, out -> "sptr"
; pcchMaxValueNameLen : DWORD* optional, out -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。
出力引数:
#uselib "SHLWAPI.dll"
#cfunc global SHQueryInfoKeyA "SHQueryInfoKeyA" sptr, var, var, var, var
; res = SHQueryInfoKeyA(hkey, pcSubKeys, pcchMaxSubKeyLen, pcValues, pcchMaxValueNameLen)
; hkey : HKEY -> "sptr"
; pcSubKeys : DWORD* optional, out -> "var"
; pcchMaxSubKeyLen : DWORD* optional, out -> "var"
; pcValues : DWORD* optional, out -> "var"
; pcchMaxValueNameLen : DWORD* optional, out -> "var"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。
出力引数:
; WIN32_ERROR SHQueryInfoKeyA(HKEY hkey, DWORD* pcSubKeys, DWORD* pcchMaxSubKeyLen, DWORD* pcValues, DWORD* pcchMaxValueNameLen)
#uselib "SHLWAPI.dll"
#cfunc global SHQueryInfoKeyA "SHQueryInfoKeyA" intptr, var, var, var, var
; res = SHQueryInfoKeyA(hkey, pcSubKeys, pcchMaxSubKeyLen, pcValues, pcchMaxValueNameLen)
; hkey : HKEY -> "intptr"
; pcSubKeys : DWORD* optional, out -> "var"
; pcchMaxSubKeyLen : DWORD* optional, out -> "var"
; pcValues : DWORD* optional, out -> "var"
; pcchMaxValueNameLen : DWORD* optional, out -> "var"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。
import (
	"golang.org/x/sys/windows"
	"unsafe"
)

var (
	shlwapi = windows.NewLazySystemDLL("SHLWAPI.dll")
	procSHQueryInfoKeyA = shlwapi.NewProc("SHQueryInfoKeyA")
)

// hkey (HKEY), pcSubKeys (DWORD* optional, out), pcchMaxSubKeyLen (DWORD* optional, out), pcValues (DWORD* optional, out), pcchMaxValueNameLen (DWORD* optional, out)
r1, _, err := procSHQueryInfoKeyA.Call(
	uintptr(hkey),
	uintptr(pcSubKeys),
	uintptr(pcchMaxSubKeyLen),
	uintptr(pcValues),
	uintptr(pcchMaxValueNameLen),
)
_ = err  // syscall.Errno (valid when the call sets last-error)
_ = r1   // WIN32_ERROR
function SHQueryInfoKeyA(
  hkey: THandle;   // HKEY
  pcSubKeys: Pointer;   // DWORD* optional, out
  pcchMaxSubKeyLen: Pointer;   // DWORD* optional, out
  pcValues: Pointer;   // DWORD* optional, out
  pcchMaxValueNameLen: Pointer   // DWORD* optional, out
): DWORD; stdcall;
  external 'SHLWAPI.dll' name 'SHQueryInfoKeyA';
result := DllCall("SHLWAPI\SHQueryInfoKeyA"
    , "Ptr", hkey   ; HKEY
    , "Ptr", pcSubKeys   ; DWORD* optional, out
    , "Ptr", pcchMaxSubKeyLen   ; DWORD* optional, out
    , "Ptr", pcValues   ; DWORD* optional, out
    , "Ptr", pcchMaxValueNameLen   ; DWORD* optional, out
    , "UInt")   ; return: WIN32_ERROR
●SHQueryInfoKeyA(hkey, pcSubKeys, pcchMaxSubKeyLen, pcValues, pcchMaxValueNameLen) = DLL("SHLWAPI.dll", "dword SHQueryInfoKeyA(void*, void*, void*, void*, void*)")
# 呼び出し: SHQueryInfoKeyA(hkey, pcSubKeys, pcchMaxSubKeyLen, pcValues, pcchMaxValueNameLen)
# hkey : HKEY -> "void*"
# pcSubKeys : DWORD* optional, out -> "void*"
# pcchMaxSubKeyLen : DWORD* optional, out -> "void*"
# pcValues : DWORD* optional, out -> "void*"
# pcchMaxValueNameLen : DWORD* optional, out -> "void*"
# なでしこ1は32bit・ANSI(Shift_JIS)。文字列=char*(ANSI)、ポインタ/ハンドル=void*(4byte)。
const std = @import("std");

extern "shlwapi" fn SHQueryInfoKeyA(
    hkey: ?*anyopaque, // HKEY
    pcSubKeys: [*c]u32, // DWORD* optional, out
    pcchMaxSubKeyLen: [*c]u32, // DWORD* optional, out
    pcValues: [*c]u32, // DWORD* optional, out
    pcchMaxValueNameLen: [*c]u32 // DWORD* optional, out
) callconv(std.os.windows.WINAPI) u32;
proc SHQueryInfoKeyA(
    hkey: pointer,  # HKEY
    pcSubKeys: ptr uint32,  # DWORD* optional, out
    pcchMaxSubKeyLen: ptr uint32,  # DWORD* optional, out
    pcValues: ptr uint32,  # DWORD* optional, out
    pcchMaxValueNameLen: ptr uint32  # DWORD* optional, out
): uint32 {.importc: "SHQueryInfoKeyA", stdcall, dynlib: "SHLWAPI.dll".}
pragma(lib, "shlwapi");
extern(Windows)
uint SHQueryInfoKeyA(
    void* hkey,   // HKEY
    uint* pcSubKeys,   // DWORD* optional, out
    uint* pcchMaxSubKeyLen,   // DWORD* optional, out
    uint* pcValues,   // DWORD* optional, out
    uint* pcchMaxValueNameLen   // DWORD* optional, out
);
ccall((:SHQueryInfoKeyA, "SHLWAPI.dll"), stdcall, UInt32,
      (Ptr{Cvoid}, Ptr{UInt32}, Ptr{UInt32}, Ptr{UInt32}, Ptr{UInt32}),
      hkey, pcSubKeys, pcchMaxSubKeyLen, pcValues, pcchMaxValueNameLen)
# hkey : HKEY -> Ptr{Cvoid}
# pcSubKeys : DWORD* optional, out -> Ptr{UInt32}
# pcchMaxSubKeyLen : DWORD* optional, out -> Ptr{UInt32}
# pcValues : DWORD* optional, out -> Ptr{UInt32}
# pcchMaxValueNameLen : DWORD* optional, out -> Ptr{UInt32}
# stdcall は 32bit のみ意味を持つ(x64 では無視)。
local ffi = require("ffi")
ffi.cdef[[
uint32_t SHQueryInfoKeyA(
    void* hkey,
    uint32_t* pcSubKeys,
    uint32_t* pcchMaxSubKeyLen,
    uint32_t* pcValues,
    uint32_t* pcchMaxValueNameLen);
]]
local shlwapi = ffi.load("shlwapi")
-- shlwapi.SHQueryInfoKeyA(hkey, pcSubKeys, pcchMaxSubKeyLen, pcValues, pcchMaxValueNameLen)
-- hkey : HKEY
-- pcSubKeys : DWORD* optional, out
-- pcchMaxSubKeyLen : DWORD* optional, out
-- pcValues : DWORD* optional, out
-- pcchMaxValueNameLen : DWORD* optional, out
-- 構造体/GUIDへのポインタは cdef が通るよう void* で表記(実型は各引数コメント参照)。値渡し構造体・enum は対応する typedef を cdef に追加すること。
const koffi = require('koffi');
const lib = koffi.load('SHLWAPI.dll');
const SHQueryInfoKeyA = lib.func('__stdcall', 'SHQueryInfoKeyA', 'uint32_t', ['void *', 'uint32_t *', 'uint32_t *', 'uint32_t *', 'uint32_t *']);
// SHQueryInfoKeyA(hkey, pcSubKeys, pcchMaxSubKeyLen, pcValues, pcchMaxValueNameLen)
// hkey : HKEY -> 'void *'
// pcSubKeys : DWORD* optional, out -> 'uint32_t *'
// pcchMaxSubKeyLen : DWORD* optional, out -> 'uint32_t *'
// pcValues : DWORD* optional, out -> 'uint32_t *'
// pcchMaxValueNameLen : DWORD* optional, out -> 'uint32_t *'
// 出力ポインタは koffi.out(...) で包む。構造体は koffi.struct で定義。
const lib = Deno.dlopen("SHLWAPI.dll", {
  SHQueryInfoKeyA: { parameters: ["pointer", "pointer", "pointer", "pointer", "pointer"], result: "u32" },
});
// lib.symbols.SHQueryInfoKeyA(hkey, pcSubKeys, pcchMaxSubKeyLen, pcValues, pcchMaxValueNameLen)
// hkey : HKEY -> "pointer"
// pcSubKeys : DWORD* optional, out -> "pointer"
// pcchMaxSubKeyLen : DWORD* optional, out -> "pointer"
// pcValues : DWORD* optional, out -> "pointer"
// pcchMaxValueNameLen : DWORD* optional, out -> "pointer"
// 文字列は "buffer"。ANSI(-A) は new TextEncoder() で UTF-8/ANSI バイト列(末尾に \x00)を渡す。
// 値渡し構造体は { struct: [ ...field types... ] } を使用。
<?php
$ffi = FFI::cdef(<<<C
uint32_t SHQueryInfoKeyA(
    void* hkey,
    uint32_t* pcSubKeys,
    uint32_t* pcchMaxSubKeyLen,
    uint32_t* pcValues,
    uint32_t* pcchMaxValueNameLen);
C, "SHLWAPI.dll");
// $ffi->SHQueryInfoKeyA(hkey, pcSubKeys, pcchMaxSubKeyLen, pcValues, pcchMaxValueNameLen);
// hkey : HKEY
// pcSubKeys : DWORD* optional, out
// pcchMaxSubKeyLen : DWORD* optional, out
// pcValues : DWORD* optional, out
// pcchMaxValueNameLen : DWORD* optional, out
// 構造体/GUIDへのポインタは cdef が通るよう void* で表記(実型は各引数コメント参照)。値渡し構造体・enum は対応する typedef を cdef に追加すること。
// WINAPI(stdcall): x64 では呼出規約が統一されるため問題なし。x86 では __stdcall 対応のラッパが必要な場合あり。
import com.sun.jna.*;
import com.sun.jna.ptr.*;
import com.sun.jna.win32.StdCallLibrary;
import com.sun.jna.win32.W32APIOptions;

public interface Shlwapi extends StdCallLibrary {
    Shlwapi INSTANCE = Native.load("shlwapi", Shlwapi.class, W32APIOptions.ASCII_OPTIONS);
    int SHQueryInfoKeyA(
        Pointer hkey,   // HKEY
        IntByReference pcSubKeys,   // DWORD* optional, out
        IntByReference pcchMaxSubKeyLen,   // DWORD* optional, out
        IntByReference pcValues,   // DWORD* optional, out
        IntByReference pcchMaxValueNameLen   // DWORD* optional, out
    );
}
@[Link("shlwapi")]
lib LibSHLWAPI
  fun SHQueryInfoKeyA = SHQueryInfoKeyA(
    hkey : Void*,   # HKEY
    pcSubKeys : UInt32*,   # DWORD* optional, out
    pcchMaxSubKeyLen : UInt32*,   # DWORD* optional, out
    pcValues : UInt32*,   # DWORD* optional, out
    pcchMaxValueNameLen : UInt32*   # DWORD* optional, out
  ) : UInt32
end
# 構造体/GUID/enum は lib 内に対応する型定義が必要。
# 呼出規約: x64 は規約統一のため OK。x86(32bit)は WINAPI=stdcall だが Crystal の fun に stdcall 付与構文がなく非対応。
import 'dart:ffi';
import 'package:ffi/ffi.dart';

typedef SHQueryInfoKeyANative = Uint32 Function(Pointer<Void>, Pointer<Uint32>, Pointer<Uint32>, Pointer<Uint32>, Pointer<Uint32>);
typedef SHQueryInfoKeyADart = int Function(Pointer<Void>, Pointer<Uint32>, Pointer<Uint32>, Pointer<Uint32>, Pointer<Uint32>);
final SHQueryInfoKeyA = DynamicLibrary.open('SHLWAPI.dll')
    .lookupFunction<SHQueryInfoKeyANative, SHQueryInfoKeyADart>('SHQueryInfoKeyA');
// hkey : HKEY -> Pointer<Void>
// pcSubKeys : DWORD* optional, out -> Pointer<Uint32>
// pcchMaxSubKeyLen : DWORD* optional, out -> Pointer<Uint32>
// pcValues : DWORD* optional, out -> Pointer<Uint32>
// pcchMaxValueNameLen : DWORD* optional, out -> Pointer<Uint32>
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。
{$mode objfpc}{$H+}
function SHQueryInfoKeyA(
  hkey: THandle;   // HKEY
  pcSubKeys: Pointer;   // DWORD* optional, out
  pcchMaxSubKeyLen: Pointer;   // DWORD* optional, out
  pcValues: Pointer;   // DWORD* optional, out
  pcchMaxValueNameLen: Pointer   // DWORD* optional, out
): DWORD; stdcall;
  external 'SHLWAPI.dll' name 'SHQueryInfoKeyA';
import Foreign
import Foreign.C.Types
import Foreign.C.String

foreign import stdcall safe "SHQueryInfoKeyA"
  c_SHQueryInfoKeyA :: Ptr () -> Ptr Word32 -> Ptr Word32 -> Ptr Word32 -> Ptr Word32 -> IO Word32
-- hkey : HKEY -> Ptr ()
-- pcSubKeys : DWORD* optional, out -> Ptr Word32
-- pcchMaxSubKeyLen : DWORD* optional, out -> Ptr Word32
-- pcValues : DWORD* optional, out -> Ptr Word32
-- pcchMaxValueNameLen : DWORD* optional, out -> Ptr Word32
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。
open Ctypes
open Foreign

let shqueryinfokeya =
  foreign "SHQueryInfoKeyA"
    ((ptr void) @-> (ptr uint32_t) @-> (ptr uint32_t) @-> (ptr uint32_t) @-> (ptr uint32_t) @-> returning uint32_t)
(* hkey : HKEY -> (ptr void) *)
(* pcSubKeys : DWORD* optional, out -> (ptr uint32_t) *)
(* pcchMaxSubKeyLen : DWORD* optional, out -> (ptr uint32_t) *)
(* pcValues : DWORD* optional, out -> (ptr uint32_t) *)
(* pcchMaxValueNameLen : DWORD* optional, out -> (ptr uint32_t) *)
(* foreign は cdecl 前提。x64 Windows では WINAPI と一致。構造体は ctypes structure を定義のこと。 *)
(cffi:define-foreign-library shlwapi (t "SHLWAPI.dll"))
(cffi:use-foreign-library shlwapi)

(cffi:defcfun ("SHQueryInfoKeyA" shquery-info-key-a :convention :stdcall) :uint32
  (hkey :pointer)   ; HKEY
  (pc-sub-keys :pointer)   ; DWORD* optional, out
  (pcch-max-sub-key-len :pointer)   ; DWORD* optional, out
  (pc-values :pointer)   ; DWORD* optional, out
  (pcch-max-value-name-len :pointer))   ; DWORD* optional, out
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。
use Win32::API;
my $SHQueryInfoKeyA = Win32::API::More->new('SHLWAPI',
    'DWORD SHQueryInfoKeyA(HANDLE hkey, LPVOID pcSubKeys, LPVOID pcchMaxSubKeyLen, LPVOID pcValues, LPVOID pcchMaxValueNameLen)');
# my $ret = $SHQueryInfoKeyA->Call($hkey, $pcSubKeys, $pcchMaxSubKeyLen, $pcValues, $pcchMaxValueNameLen);
# hkey : HKEY -> HANDLE
# pcSubKeys : DWORD* optional, out -> LPVOID
# pcchMaxSubKeyLen : DWORD* optional, out -> LPVOID
# pcValues : DWORD* optional, out -> LPVOID
# pcchMaxValueNameLen : DWORD* optional, out -> LPVOID
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。

関連項目

文字セット違い
使用する型