Win32 API 日本語リファレンス
ホーム › Devices.DeviceAndDriverInstallation › SetupDiGetClassPropertyKeys

SetupDiGetClassPropertyKeys

関数
デバイスクラスのプロパティキー一覧を取得する。
DLLSETUPAPI.dll呼出規約winapiSetLastErrorあり対応OSWindows Vista 以降
📘 Microsoft Learn (日本語) · English

シグネチャ

// SETUPAPI.dll
#include <windows.h>

BOOL SetupDiGetClassPropertyKeys(
    const GUID* ClassGuid,
    DEVPROPKEY* PropertyKeyArray,   // optional
    DWORD PropertyKeyCount,
    DWORD* RequiredPropertyKeyCount,   // optional
    DWORD Flags
);

パラメーター

名前型方向説明
ClassGuidGUID*inプロパティキーを列挙する対象クラスのGUID。
PropertyKeyArrayDEVPROPKEY*outoptionalクラスが保持するDEVPROPKEY群を受け取る配列。
PropertyKeyCountDWORDinPropertyKeyArrayが保持できるキー要素数。
RequiredPropertyKeyCountDWORD*outoptional実際に必要なキー要素数を受け取るポインタ。サイズ照会に使う。NULL可。
FlagsDWORDin対象クラス種別フラグ。DICLASSPROP_INSTALLERかDICLASSPROP_INTERFACEを指定する。

戻り値の型: BOOL

各言語での呼び出し定義

// SETUPAPI.dll
#include <windows.h>

BOOL SetupDiGetClassPropertyKeys(
    const GUID* ClassGuid,
    DEVPROPKEY* PropertyKeyArray,   // optional
    DWORD PropertyKeyCount,
    DWORD* RequiredPropertyKeyCount,   // optional
    DWORD Flags
);
[return: MarshalAs(UnmanagedType.Bool)]
[DllImport("SETUPAPI.dll", SetLastError = true, ExactSpelling = true)]
static extern bool SetupDiGetClassPropertyKeys(
    ref Guid ClassGuid,   // GUID*
    IntPtr PropertyKeyArray,   // DEVPROPKEY* optional, out
    uint PropertyKeyCount,   // DWORD
    IntPtr RequiredPropertyKeyCount,   // DWORD* optional, out
    uint Flags   // DWORD
);
<DllImport("SETUPAPI.dll", SetLastError:=True, ExactSpelling:=True)>
Public Shared Function SetupDiGetClassPropertyKeys(
    ByRef ClassGuid As Guid,   ' GUID*
    PropertyKeyArray As IntPtr,   ' DEVPROPKEY* optional, out
    PropertyKeyCount As UInteger,   ' DWORD
    RequiredPropertyKeyCount As IntPtr,   ' DWORD* optional, out
    Flags As UInteger   ' DWORD
) As <MarshalAs(UnmanagedType.Bool)> Boolean
End Function
' ClassGuid : GUID*
' PropertyKeyArray : DEVPROPKEY* optional, out
' PropertyKeyCount : DWORD
' RequiredPropertyKeyCount : DWORD* optional, out
' Flags : DWORD
Declare PtrSafe Function SetupDiGetClassPropertyKeys Lib "setupapi" ( _
    ByVal ClassGuid As LongPtr, _
    ByVal PropertyKeyArray As LongPtr, _
    ByVal PropertyKeyCount As Long, _
    ByVal RequiredPropertyKeyCount As LongPtr, _
    ByVal Flags As Long) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。
import ctypes
from ctypes import wintypes

SetupDiGetClassPropertyKeys = ctypes.windll.setupapi.SetupDiGetClassPropertyKeys
SetupDiGetClassPropertyKeys.restype = wintypes.BOOL
SetupDiGetClassPropertyKeys.argtypes = [
    ctypes.c_void_p,  # ClassGuid : GUID*
    ctypes.c_void_p,  # PropertyKeyArray : DEVPROPKEY* optional, out
    wintypes.DWORD,  # PropertyKeyCount : DWORD
    ctypes.POINTER(wintypes.DWORD),  # RequiredPropertyKeyCount : DWORD* optional, out
    wintypes.DWORD,  # Flags : DWORD
]
# GetLastError: use ctypes.GetLastError() (or ctypes.WinDLL(use_last_error=True))
require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('SETUPAPI.dll')
SetupDiGetClassPropertyKeys = Fiddle::Function.new(
  lib['SetupDiGetClassPropertyKeys'],
  [
    Fiddle::TYPE_VOIDP,  # ClassGuid : GUID*
    Fiddle::TYPE_VOIDP,  # PropertyKeyArray : DEVPROPKEY* optional, out
    -Fiddle::TYPE_INT,  # PropertyKeyCount : DWORD
    Fiddle::TYPE_VOIDP,  # RequiredPropertyKeyCount : DWORD* optional, out
    -Fiddle::TYPE_INT,  # Flags : DWORD
  ],
  Fiddle::TYPE_INT)
#[link(name = "setupapi")]
extern "system" {
    fn SetupDiGetClassPropertyKeys(
        ClassGuid: *const GUID,  // GUID*
        PropertyKeyArray: *mut DEVPROPKEY,  // DEVPROPKEY* optional, out
        PropertyKeyCount: u32,  // DWORD
        RequiredPropertyKeyCount: *mut u32,  // DWORD* optional, out
        Flags: u32  // DWORD
    ) -> i32;
}
// crates: windows-sys provides ready-made bindings for this API.
$sig = @"
[return: MarshalAs(UnmanagedType.Bool)]
[DllImport("SETUPAPI.dll", SetLastError = true)]
public static extern bool SetupDiGetClassPropertyKeys(ref Guid ClassGuid, IntPtr PropertyKeyArray, uint PropertyKeyCount, IntPtr RequiredPropertyKeyCount, uint Flags);
"@
$api = Add-Type -MemberDefinition $sig -Name 'SETUPAPI_SetupDiGetClassPropertyKeys' -Namespace Win32 -PassThru
# $api::SetupDiGetClassPropertyKeys(ClassGuid, PropertyKeyArray, PropertyKeyCount, RequiredPropertyKeyCount, Flags)
#uselib "SETUPAPI.dll"
#func global SetupDiGetClassPropertyKeys "SetupDiGetClassPropertyKeys" sptr, sptr, sptr, sptr, sptr
; SetupDiGetClassPropertyKeys varptr(ClassGuid), varptr(PropertyKeyArray), PropertyKeyCount, varptr(RequiredPropertyKeyCount), Flags   ; 戻り値は stat
; ClassGuid : GUID* -> "sptr"
; PropertyKeyArray : DEVPROPKEY* optional, out -> "sptr"
; PropertyKeyCount : DWORD -> "sptr"
; RequiredPropertyKeyCount : DWORD* optional, out -> "sptr"
; Flags : DWORD -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。
出力引数: 
#uselib "SETUPAPI.dll"
#cfunc global SetupDiGetClassPropertyKeys "SetupDiGetClassPropertyKeys" var, var, int, var, int
; res = SetupDiGetClassPropertyKeys(ClassGuid, PropertyKeyArray, PropertyKeyCount, RequiredPropertyKeyCount, Flags)
; ClassGuid : GUID* -> "var"
; PropertyKeyArray : DEVPROPKEY* optional, out -> "var"
; PropertyKeyCount : DWORD -> "int"
; RequiredPropertyKeyCount : DWORD* optional, out -> "var"
; Flags : DWORD -> "int"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。
出力引数: 
; BOOL SetupDiGetClassPropertyKeys(GUID* ClassGuid, DEVPROPKEY* PropertyKeyArray, DWORD PropertyKeyCount, DWORD* RequiredPropertyKeyCount, DWORD Flags)
#uselib "SETUPAPI.dll"
#cfunc global SetupDiGetClassPropertyKeys "SetupDiGetClassPropertyKeys" var, var, int, var, int
; res = SetupDiGetClassPropertyKeys(ClassGuid, PropertyKeyArray, PropertyKeyCount, RequiredPropertyKeyCount, Flags)
; ClassGuid : GUID* -> "var"
; PropertyKeyArray : DEVPROPKEY* optional, out -> "var"
; PropertyKeyCount : DWORD -> "int"
; RequiredPropertyKeyCount : DWORD* optional, out -> "var"
; Flags : DWORD -> "int"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。
import (
	"golang.org/x/sys/windows"
	"unsafe"
)

var (
	setupapi = windows.NewLazySystemDLL("SETUPAPI.dll")
	procSetupDiGetClassPropertyKeys = setupapi.NewProc("SetupDiGetClassPropertyKeys")
)

// ClassGuid (GUID*), PropertyKeyArray (DEVPROPKEY* optional, out), PropertyKeyCount (DWORD), RequiredPropertyKeyCount (DWORD* optional, out), Flags (DWORD)
r1, _, err := procSetupDiGetClassPropertyKeys.Call(
	uintptr(ClassGuid),
	uintptr(PropertyKeyArray),
	uintptr(PropertyKeyCount),
	uintptr(RequiredPropertyKeyCount),
	uintptr(Flags),
)
_ = err  // syscall.Errno (valid when the call sets last-error)
_ = r1   // BOOL
function SetupDiGetClassPropertyKeys(
  ClassGuid: PGUID;   // GUID*
  PropertyKeyArray: Pointer;   // DEVPROPKEY* optional, out
  PropertyKeyCount: DWORD;   // DWORD
  RequiredPropertyKeyCount: Pointer;   // DWORD* optional, out
  Flags: DWORD   // DWORD
): BOOL; stdcall;
  external 'SETUPAPI.dll' name 'SetupDiGetClassPropertyKeys';
result := DllCall("SETUPAPI\SetupDiGetClassPropertyKeys"
    , "Ptr", ClassGuid   ; GUID*
    , "Ptr", PropertyKeyArray   ; DEVPROPKEY* optional, out
    , "UInt", PropertyKeyCount   ; DWORD
    , "Ptr", RequiredPropertyKeyCount   ; DWORD* optional, out
    , "UInt", Flags   ; DWORD
    , "Int")   ; return: BOOL
●SetupDiGetClassPropertyKeys(ClassGuid, PropertyKeyArray, PropertyKeyCount, RequiredPropertyKeyCount, Flags) = DLL("SETUPAPI.dll", "bool SetupDiGetClassPropertyKeys(void*, void*, dword, void*, dword)")
# 呼び出し: SetupDiGetClassPropertyKeys(ClassGuid, PropertyKeyArray, PropertyKeyCount, RequiredPropertyKeyCount, Flags)
# ClassGuid : GUID* -> "void*"
# PropertyKeyArray : DEVPROPKEY* optional, out -> "void*"
# PropertyKeyCount : DWORD -> "dword"
# RequiredPropertyKeyCount : DWORD* optional, out -> "void*"
# Flags : DWORD -> "dword"
# なでしこ1は32bit・ANSI(Shift_JIS)。文字列=char*(ANSI)、ポインタ/ハンドル=void*(4byte)。
const std = @import("std");

extern "setupapi" fn SetupDiGetClassPropertyKeys(
    ClassGuid: [*c]GUID, // GUID*
    PropertyKeyArray: [*c]DEVPROPKEY, // DEVPROPKEY* optional, out
    PropertyKeyCount: u32, // DWORD
    RequiredPropertyKeyCount: [*c]u32, // DWORD* optional, out
    Flags: u32 // DWORD
) callconv(std.os.windows.WINAPI) i32;
proc SetupDiGetClassPropertyKeys(
    ClassGuid: ptr GUID,  # GUID*
    PropertyKeyArray: ptr DEVPROPKEY,  # DEVPROPKEY* optional, out
    PropertyKeyCount: uint32,  # DWORD
    RequiredPropertyKeyCount: ptr uint32,  # DWORD* optional, out
    Flags: uint32  # DWORD
): int32 {.importc: "SetupDiGetClassPropertyKeys", stdcall, dynlib: "SETUPAPI.dll".}
pragma(lib, "setupapi");
extern(Windows)
int SetupDiGetClassPropertyKeys(
    GUID* ClassGuid,   // GUID*
    DEVPROPKEY* PropertyKeyArray,   // DEVPROPKEY* optional, out
    uint PropertyKeyCount,   // DWORD
    uint* RequiredPropertyKeyCount,   // DWORD* optional, out
    uint Flags   // DWORD
);
ccall((:SetupDiGetClassPropertyKeys, "SETUPAPI.dll"), stdcall, Int32,
      (Ptr{GUID}, Ptr{DEVPROPKEY}, UInt32, Ptr{UInt32}, UInt32),
      ClassGuid, PropertyKeyArray, PropertyKeyCount, RequiredPropertyKeyCount, Flags)
# ClassGuid : GUID* -> Ptr{GUID}
# PropertyKeyArray : DEVPROPKEY* optional, out -> Ptr{DEVPROPKEY}
# PropertyKeyCount : DWORD -> UInt32
# RequiredPropertyKeyCount : DWORD* optional, out -> Ptr{UInt32}
# Flags : DWORD -> UInt32
# stdcall は 32bit のみ意味を持つ(x64 では無視)。
local ffi = require("ffi")
ffi.cdef[[
int32_t SetupDiGetClassPropertyKeys(
    void* ClassGuid,
    void* PropertyKeyArray,
    uint32_t PropertyKeyCount,
    uint32_t* RequiredPropertyKeyCount,
    uint32_t Flags);
]]
local setupapi = ffi.load("setupapi")
-- setupapi.SetupDiGetClassPropertyKeys(ClassGuid, PropertyKeyArray, PropertyKeyCount, RequiredPropertyKeyCount, Flags)
-- ClassGuid : GUID*
-- PropertyKeyArray : DEVPROPKEY* optional, out
-- PropertyKeyCount : DWORD
-- RequiredPropertyKeyCount : DWORD* optional, out
-- Flags : DWORD
-- 構造体/GUIDへのポインタは cdef が通るよう void* で表記(実型は各引数コメント参照)。値渡し構造体・enum は対応する typedef を cdef に追加すること。
const koffi = require('koffi');
const lib = koffi.load('SETUPAPI.dll');
const SetupDiGetClassPropertyKeys = lib.func('__stdcall', 'SetupDiGetClassPropertyKeys', 'int32_t', ['void *', 'void *', 'uint32_t', 'uint32_t *', 'uint32_t']);
// SetupDiGetClassPropertyKeys(ClassGuid, PropertyKeyArray, PropertyKeyCount, RequiredPropertyKeyCount, Flags)
// ClassGuid : GUID* -> 'void *'
// PropertyKeyArray : DEVPROPKEY* optional, out -> 'void *'
// PropertyKeyCount : DWORD -> 'uint32_t'
// RequiredPropertyKeyCount : DWORD* optional, out -> 'uint32_t *'
// Flags : DWORD -> 'uint32_t'
// 出力ポインタは koffi.out(...) で包む。構造体は koffi.struct で定義。
const lib = Deno.dlopen("SETUPAPI.dll", {
  SetupDiGetClassPropertyKeys: { parameters: ["pointer", "pointer", "u32", "pointer", "u32"], result: "i32" },
});
// lib.symbols.SetupDiGetClassPropertyKeys(ClassGuid, PropertyKeyArray, PropertyKeyCount, RequiredPropertyKeyCount, Flags)
// ClassGuid : GUID* -> "pointer"
// PropertyKeyArray : DEVPROPKEY* optional, out -> "pointer"
// PropertyKeyCount : DWORD -> "u32"
// RequiredPropertyKeyCount : DWORD* optional, out -> "pointer"
// Flags : DWORD -> "u32"
// 文字列引数は "buffer"(NUL 終端のバイト列を Uint8Array で渡す)。
// 値渡し構造体は { struct: [ ...field types... ] } を使用。
<?php
$ffi = FFI::cdef(<<<C
int32_t SetupDiGetClassPropertyKeys(
    void* ClassGuid,
    void* PropertyKeyArray,
    uint32_t PropertyKeyCount,
    uint32_t* RequiredPropertyKeyCount,
    uint32_t Flags);
C, "SETUPAPI.dll");
// $ffi->SetupDiGetClassPropertyKeys(ClassGuid, PropertyKeyArray, PropertyKeyCount, RequiredPropertyKeyCount, Flags);
// ClassGuid : GUID*
// PropertyKeyArray : DEVPROPKEY* optional, out
// PropertyKeyCount : DWORD
// RequiredPropertyKeyCount : DWORD* optional, out
// Flags : DWORD
// 構造体/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 Setupapi extends StdCallLibrary {
    Setupapi INSTANCE = Native.load("setupapi", Setupapi.class);
    boolean SetupDiGetClassPropertyKeys(
        Pointer ClassGuid,   // GUID*
        Pointer PropertyKeyArray,   // DEVPROPKEY* optional, out
        int PropertyKeyCount,   // DWORD
        IntByReference RequiredPropertyKeyCount,   // DWORD* optional, out
        int Flags   // DWORD
    );
}
@[Link("setupapi")]
lib LibSETUPAPI
  fun SetupDiGetClassPropertyKeys = SetupDiGetClassPropertyKeys(
    ClassGuid : GUID*,   # GUID*
    PropertyKeyArray : DEVPROPKEY*,   # DEVPROPKEY* optional, out
    PropertyKeyCount : UInt32,   # DWORD
    RequiredPropertyKeyCount : UInt32*,   # DWORD* optional, out
    Flags : UInt32   # DWORD
  ) : Int32
end
# 構造体/GUID/enum は lib 内に対応する型定義が必要。
# 呼出規約: x64 は規約統一のため OK。x86(32bit)は WINAPI=stdcall だが Crystal の fun に stdcall 付与構文がなく非対応。
import 'dart:ffi';
import 'package:ffi/ffi.dart';

typedef SetupDiGetClassPropertyKeysNative = Int32 Function(Pointer<Void>, Pointer<Void>, Uint32, Pointer<Uint32>, Uint32);
typedef SetupDiGetClassPropertyKeysDart = int Function(Pointer<Void>, Pointer<Void>, int, Pointer<Uint32>, int);
final SetupDiGetClassPropertyKeys = DynamicLibrary.open('SETUPAPI.dll')
    .lookupFunction<SetupDiGetClassPropertyKeysNative, SetupDiGetClassPropertyKeysDart>('SetupDiGetClassPropertyKeys');
// ClassGuid : GUID* -> Pointer<Void>
// PropertyKeyArray : DEVPROPKEY* optional, out -> Pointer<Void>
// PropertyKeyCount : DWORD -> Uint32
// RequiredPropertyKeyCount : DWORD* optional, out -> Pointer<Uint32>
// Flags : DWORD -> Uint32
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。
{$mode objfpc}{$H+}
function SetupDiGetClassPropertyKeys(
  ClassGuid: PGUID;   // GUID*
  PropertyKeyArray: Pointer;   // DEVPROPKEY* optional, out
  PropertyKeyCount: DWORD;   // DWORD
  RequiredPropertyKeyCount: Pointer;   // DWORD* optional, out
  Flags: DWORD   // DWORD
): BOOL; stdcall;
  external 'SETUPAPI.dll' name 'SetupDiGetClassPropertyKeys';
import Foreign
import Foreign.C.Types
import Foreign.C.String

foreign import stdcall safe "SetupDiGetClassPropertyKeys"
  c_SetupDiGetClassPropertyKeys :: Ptr () -> Ptr () -> Word32 -> Ptr Word32 -> Word32 -> IO CInt
-- ClassGuid : GUID* -> Ptr ()
-- PropertyKeyArray : DEVPROPKEY* optional, out -> Ptr ()
-- PropertyKeyCount : DWORD -> Word32
-- RequiredPropertyKeyCount : DWORD* optional, out -> Ptr Word32
-- Flags : DWORD -> Word32
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。
open Ctypes
open Foreign

let setupdigetclasspropertykeys =
  foreign "SetupDiGetClassPropertyKeys"
    ((ptr void) @-> (ptr void) @-> uint32_t @-> (ptr uint32_t) @-> uint32_t @-> returning int32_t)
(* ClassGuid : GUID* -> (ptr void) *)
(* PropertyKeyArray : DEVPROPKEY* optional, out -> (ptr void) *)
(* PropertyKeyCount : DWORD -> uint32_t *)
(* RequiredPropertyKeyCount : DWORD* optional, out -> (ptr uint32_t) *)
(* Flags : DWORD -> uint32_t *)
(* foreign は cdecl 前提。x64 Windows では WINAPI と一致。構造体は ctypes structure を定義のこと。 *)
(cffi:define-foreign-library setupapi (t "SETUPAPI.dll"))
(cffi:use-foreign-library setupapi)

(cffi:defcfun ("SetupDiGetClassPropertyKeys" setup-di-get-class-property-keys :convention :stdcall) :int32
  (class-guid :pointer)   ; GUID*
  (property-key-array :pointer)   ; DEVPROPKEY* optional, out
  (property-key-count :uint32)   ; DWORD
  (required-property-key-count :pointer)   ; DWORD* optional, out
  (flags :uint32))   ; DWORD
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。
use Win32::API;
my $SetupDiGetClassPropertyKeys = Win32::API::More->new('SETUPAPI',
    'BOOL SetupDiGetClassPropertyKeys(LPVOID ClassGuid, LPVOID PropertyKeyArray, DWORD PropertyKeyCount, LPVOID RequiredPropertyKeyCount, DWORD Flags)');
# my $ret = $SetupDiGetClassPropertyKeys->Call($ClassGuid, $PropertyKeyArray, $PropertyKeyCount, $RequiredPropertyKeyCount, $Flags);
# ClassGuid : GUID* -> LPVOID
# PropertyKeyArray : DEVPROPKEY* optional, out -> LPVOID
# PropertyKeyCount : DWORD -> DWORD
# RequiredPropertyKeyCount : DWORD* optional, out -> LPVOID
# Flags : DWORD -> DWORD
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。

関連項目

使用する型