ホーム › Devices.DeviceAndDriverInstallation › SetupDiGetClassPropertyKeysExW

SetupDiGetClassPropertyKeysExW

関数

リモート対応でデバイスクラスのプロパティキー一覧を取得する。

DLLSETUPAPI.dll呼出規約winapiSetLastErrorあり対応OSWindows Vista 以降

シグネチャ

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

BOOL SetupDiGetClassPropertyKeysExW(
    const GUID* ClassGuid,
    DEVPROPKEY* PropertyKeyArray,   // optional
    DWORD PropertyKeyCount,
    DWORD* RequiredPropertyKeyCount,   // optional
    DWORD Flags,
    LPCWSTR MachineName,   // optional
    void* Reserved   // optional
);

パラメーター

名前	型	方向
ClassGuid	GUID*	in
PropertyKeyArray	DEVPROPKEY*	outoptional
PropertyKeyCount	DWORD	in
RequiredPropertyKeyCount	DWORD*	outoptional
Flags	DWORD	in
MachineName	LPCWSTR	inoptional
Reserved	void*	optional

戻り値の型: BOOL

各言語での呼び出し定義

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

BOOL SetupDiGetClassPropertyKeysExW(
    const GUID* ClassGuid,
    DEVPROPKEY* PropertyKeyArray,   // optional
    DWORD PropertyKeyCount,
    DWORD* RequiredPropertyKeyCount,   // optional
    DWORD Flags,
    LPCWSTR MachineName,   // optional
    void* Reserved   // optional
);

[return: MarshalAs(UnmanagedType.Bool)]
[DllImport("SETUPAPI.dll", SetLastError = true, ExactSpelling = true)]
static extern bool SetupDiGetClassPropertyKeysExW(
    ref Guid ClassGuid,   // GUID*
    IntPtr PropertyKeyArray,   // DEVPROPKEY* optional, out
    uint PropertyKeyCount,   // DWORD
    IntPtr RequiredPropertyKeyCount,   // DWORD* optional, out
    uint Flags,   // DWORD
    [MarshalAs(UnmanagedType.LPWStr)] string MachineName,   // LPCWSTR optional
    IntPtr Reserved   // void* optional
);

<DllImport("SETUPAPI.dll", SetLastError:=True, ExactSpelling:=True)>
Public Shared Function SetupDiGetClassPropertyKeysExW(
    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
    <MarshalAs(UnmanagedType.LPWStr)> MachineName As String,   ' LPCWSTR optional
    Reserved As IntPtr   ' void* optional
) As Boolean
End Function

' ClassGuid : GUID*
' PropertyKeyArray : DEVPROPKEY* optional, out
' PropertyKeyCount : DWORD
' RequiredPropertyKeyCount : DWORD* optional, out
' Flags : DWORD
' MachineName : LPCWSTR optional
' Reserved : void* optional
Declare PtrSafe Function SetupDiGetClassPropertyKeysExW Lib "setupapi" ( _
    ByVal ClassGuid As LongPtr, _
    ByVal PropertyKeyArray As LongPtr, _
    ByVal PropertyKeyCount As Long, _
    ByVal RequiredPropertyKeyCount As LongPtr, _
    ByVal Flags As Long, _
    ByVal MachineName As LongPtr, _
    ByVal Reserved As LongPtr) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。

import ctypes
from ctypes import wintypes

SetupDiGetClassPropertyKeysExW = ctypes.windll.setupapi.SetupDiGetClassPropertyKeysExW
SetupDiGetClassPropertyKeysExW.restype = wintypes.BOOL
SetupDiGetClassPropertyKeysExW.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
    wintypes.LPCWSTR,  # MachineName : LPCWSTR optional
    ctypes.POINTER(None),  # Reserved : void* optional
]
# GetLastError: use ctypes.GetLastError() (or ctypes.WinDLL(use_last_error=True))

require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('SETUPAPI.dll')
SetupDiGetClassPropertyKeysExW = Fiddle::Function.new(
  lib['SetupDiGetClassPropertyKeysExW'],
  [
    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_VOIDP,  # MachineName : LPCWSTR optional
    Fiddle::TYPE_VOIDP,  # Reserved : void* optional
  ],
  Fiddle::TYPE_INT)

#[link(name = "setupapi")]
extern "system" {
    fn SetupDiGetClassPropertyKeysExW(
        ClassGuid: *const GUID,  // GUID*
        PropertyKeyArray: *mut DEVPROPKEY,  // DEVPROPKEY* optional, out
        PropertyKeyCount: u32,  // DWORD
        RequiredPropertyKeyCount: *mut u32,  // DWORD* optional, out
        Flags: u32,  // DWORD
        MachineName: *const u16,  // LPCWSTR optional
        Reserved: *mut ()  // void* optional
    ) -> 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 SetupDiGetClassPropertyKeysExW(ref Guid ClassGuid, IntPtr PropertyKeyArray, uint PropertyKeyCount, IntPtr RequiredPropertyKeyCount, uint Flags, [MarshalAs(UnmanagedType.LPWStr)] string MachineName, IntPtr Reserved);
"@
$api = Add-Type -MemberDefinition $sig -Name 'SETUPAPI_SetupDiGetClassPropertyKeysExW' -Namespace Win32 -PassThru
# $api::SetupDiGetClassPropertyKeysExW(ClassGuid, PropertyKeyArray, PropertyKeyCount, RequiredPropertyKeyCount, Flags, MachineName, Reserved)

#uselib "SETUPAPI.dll"
#func global SetupDiGetClassPropertyKeysExW "SetupDiGetClassPropertyKeysExW" sptr, sptr, sptr, sptr, sptr, sptr, sptr
; SetupDiGetClassPropertyKeysExW varptr(ClassGuid), varptr(PropertyKeyArray), PropertyKeyCount, varptr(RequiredPropertyKeyCount), Flags, MachineName, Reserved   ; 戻り値は stat
; ClassGuid : GUID* -> "sptr"
; PropertyKeyArray : DEVPROPKEY* optional, out -> "sptr"
; PropertyKeyCount : DWORD -> "sptr"
; RequiredPropertyKeyCount : DWORD* optional, out -> "sptr"
; Flags : DWORD -> "sptr"
; MachineName : LPCWSTR optional -> "sptr"
; Reserved : void* optional -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。

出力引数:

#uselib "SETUPAPI.dll"
#cfunc global SetupDiGetClassPropertyKeysExW "SetupDiGetClassPropertyKeysExW" var, var, int, var, int, wstr, sptr
; res = SetupDiGetClassPropertyKeysExW(ClassGuid, PropertyKeyArray, PropertyKeyCount, RequiredPropertyKeyCount, Flags, MachineName, Reserved)
; ClassGuid : GUID* -> "var"
; PropertyKeyArray : DEVPROPKEY* optional, out -> "var"
; PropertyKeyCount : DWORD -> "int"
; RequiredPropertyKeyCount : DWORD* optional, out -> "var"
; Flags : DWORD -> "int"
; MachineName : LPCWSTR optional -> "wstr"
; Reserved : void* optional -> "sptr"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。#uselib "SETUPAPI.dll"
#cfunc global SetupDiGetClassPropertyKeysExW "SetupDiGetClassPropertyKeysExW" sptr, sptr, int, sptr, int, wstr, sptr
; res = SetupDiGetClassPropertyKeysExW(varptr(ClassGuid), varptr(PropertyKeyArray), PropertyKeyCount, varptr(RequiredPropertyKeyCount), Flags, MachineName, Reserved)
; ClassGuid : GUID* -> "sptr"
; PropertyKeyArray : DEVPROPKEY* optional, out -> "sptr"
; PropertyKeyCount : DWORD -> "int"
; RequiredPropertyKeyCount : DWORD* optional, out -> "sptr"
; Flags : DWORD -> "int"
; MachineName : LPCWSTR optional -> "wstr"
; Reserved : void* optional -> "sptr"
; ※出力/バッファ引数はポインタ方式(token=sptr / 呼び出しは varptr(変数))。

出力引数:

; BOOL SetupDiGetClassPropertyKeysExW(GUID* ClassGuid, DEVPROPKEY* PropertyKeyArray, DWORD PropertyKeyCount, DWORD* RequiredPropertyKeyCount, DWORD Flags, LPCWSTR MachineName, void* Reserved)
#uselib "SETUPAPI.dll"
#cfunc global SetupDiGetClassPropertyKeysExW "SetupDiGetClassPropertyKeysExW" var, var, int, var, int, wstr, intptr
; res = SetupDiGetClassPropertyKeysExW(ClassGuid, PropertyKeyArray, PropertyKeyCount, RequiredPropertyKeyCount, Flags, MachineName, Reserved)
; ClassGuid : GUID* -> "var"
; PropertyKeyArray : DEVPROPKEY* optional, out -> "var"
; PropertyKeyCount : DWORD -> "int"
; RequiredPropertyKeyCount : DWORD* optional, out -> "var"
; Flags : DWORD -> "int"
; MachineName : LPCWSTR optional -> "wstr"
; Reserved : void* optional -> "intptr"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。; BOOL SetupDiGetClassPropertyKeysExW(GUID* ClassGuid, DEVPROPKEY* PropertyKeyArray, DWORD PropertyKeyCount, DWORD* RequiredPropertyKeyCount, DWORD Flags, LPCWSTR MachineName, void* Reserved)
#uselib "SETUPAPI.dll"
#cfunc global SetupDiGetClassPropertyKeysExW "SetupDiGetClassPropertyKeysExW" intptr, intptr, int, intptr, int, wstr, intptr
; res = SetupDiGetClassPropertyKeysExW(varptr(ClassGuid), varptr(PropertyKeyArray), PropertyKeyCount, varptr(RequiredPropertyKeyCount), Flags, MachineName, Reserved)
; ClassGuid : GUID* -> "intptr"
; PropertyKeyArray : DEVPROPKEY* optional, out -> "intptr"
; PropertyKeyCount : DWORD -> "int"
; RequiredPropertyKeyCount : DWORD* optional, out -> "intptr"
; Flags : DWORD -> "int"
; MachineName : LPCWSTR optional -> "wstr"
; Reserved : void* optional -> "intptr"
; ※出力/バッファ引数はポインタ方式(token=intptr / 呼び出しは varptr(変数))。

import (
	"golang.org/x/sys/windows"
	"unsafe"
)

var (
	setupapi = windows.NewLazySystemDLL("SETUPAPI.dll")
	procSetupDiGetClassPropertyKeysExW = setupapi.NewProc("SetupDiGetClassPropertyKeysExW")
)

// ClassGuid (GUID*), PropertyKeyArray (DEVPROPKEY* optional, out), PropertyKeyCount (DWORD), RequiredPropertyKeyCount (DWORD* optional, out), Flags (DWORD), MachineName (LPCWSTR optional), Reserved (void* optional)
r1, _, err := procSetupDiGetClassPropertyKeysExW.Call(
	uintptr(ClassGuid),
	uintptr(PropertyKeyArray),
	uintptr(PropertyKeyCount),
	uintptr(RequiredPropertyKeyCount),
	uintptr(Flags),
	uintptr(unsafe.Pointer(windows.StringToUTF16Ptr(MachineName))),
	uintptr(Reserved),
)
_ = err  // syscall.Errno (valid when the call sets last-error)
_ = r1   // BOOL

function SetupDiGetClassPropertyKeysExW(
  ClassGuid: PGUID;   // GUID*
  PropertyKeyArray: Pointer;   // DEVPROPKEY* optional, out
  PropertyKeyCount: DWORD;   // DWORD
  RequiredPropertyKeyCount: Pointer;   // DWORD* optional, out
  Flags: DWORD;   // DWORD
  MachineName: PWideChar;   // LPCWSTR optional
  Reserved: Pointer   // void* optional
): BOOL; stdcall;
  external 'SETUPAPI.dll' name 'SetupDiGetClassPropertyKeysExW';

result := DllCall("SETUPAPI\SetupDiGetClassPropertyKeysExW"
    , "Ptr", ClassGuid   ; GUID*
    , "Ptr", PropertyKeyArray   ; DEVPROPKEY* optional, out
    , "UInt", PropertyKeyCount   ; DWORD
    , "Ptr", RequiredPropertyKeyCount   ; DWORD* optional, out
    , "UInt", Flags   ; DWORD
    , "WStr", MachineName   ; LPCWSTR optional
    , "Ptr", Reserved   ; void* optional
    , "Int")   ; return: BOOL

●SetupDiGetClassPropertyKeysExW(ClassGuid, PropertyKeyArray, PropertyKeyCount, RequiredPropertyKeyCount, Flags, MachineName, Reserved) = DLL("SETUPAPI.dll", "bool SetupDiGetClassPropertyKeysExW(void*, void*, dword, void*, dword, char*, void*)")
# 呼び出し: SetupDiGetClassPropertyKeysExW(ClassGuid, PropertyKeyArray, PropertyKeyCount, RequiredPropertyKeyCount, Flags, MachineName, Reserved)
# ClassGuid : GUID* -> "void*"
# PropertyKeyArray : DEVPROPKEY* optional, out -> "void*"
# PropertyKeyCount : DWORD -> "dword"
# RequiredPropertyKeyCount : DWORD* optional, out -> "void*"
# Flags : DWORD -> "dword"
# MachineName : LPCWSTR optional -> "char*"
# Reserved : void* optional -> "void*"
# なでしこ1は32bit・ANSI(Shift_JIS)。文字列=char*(ANSI)、ポインタ/ハンドル=void*(4byte)。