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

SetupDiGetClassPropertyKeys

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

シグネチャ

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

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

パラメーター

名前方向
ClassGuidGUID*in
PropertyKeyArrayDEVPROPKEY*outoptional
PropertyKeyCountDWORDin
RequiredPropertyKeyCountDWORD*outoptional
FlagsDWORDin

戻り値の型: 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 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)。