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

SetupDiGetDeviceInstanceIdW

関数
デバイス情報要素のデバイスインスタンスIDを取得する。
DLLSETUPAPI.dll文字セットUnicode (-W)呼出規約winapiSetLastErrorあり対応OSWindows 2000 以降

シグネチャ

// SETUPAPI.dll  (Unicode / -W)
#include <windows.h>

BOOL SetupDiGetDeviceInstanceIdW(
    HDEVINFO DeviceInfoSet,
    SP_DEVINFO_DATA* DeviceInfoData,
    LPWSTR DeviceInstanceId,   // optional
    DWORD DeviceInstanceIdSize,
    DWORD* RequiredSize   // optional
);

パラメーター

名前方向
DeviceInfoSetHDEVINFOin
DeviceInfoDataSP_DEVINFO_DATA*in
DeviceInstanceIdLPWSTRoutoptional
DeviceInstanceIdSizeDWORDin
RequiredSizeDWORD*outoptional

戻り値の型: BOOL

各言語での呼び出し定義

// SETUPAPI.dll  (Unicode / -W)
#include <windows.h>

BOOL SetupDiGetDeviceInstanceIdW(
    HDEVINFO DeviceInfoSet,
    SP_DEVINFO_DATA* DeviceInfoData,
    LPWSTR DeviceInstanceId,   // optional
    DWORD DeviceInstanceIdSize,
    DWORD* RequiredSize   // optional
);
[return: MarshalAs(UnmanagedType.Bool)]
[DllImport("SETUPAPI.dll", CharSet = CharSet.Unicode, SetLastError = true, ExactSpelling = true)]
static extern bool SetupDiGetDeviceInstanceIdW(
    IntPtr DeviceInfoSet,   // HDEVINFO
    IntPtr DeviceInfoData,   // SP_DEVINFO_DATA*
    [MarshalAs(UnmanagedType.LPWStr)] System.Text.StringBuilder DeviceInstanceId,   // LPWSTR optional, out
    uint DeviceInstanceIdSize,   // DWORD
    IntPtr RequiredSize   // DWORD* optional, out
);
<DllImport("SETUPAPI.dll", CharSet:=CharSet.Unicode, SetLastError:=True, ExactSpelling:=True)>
Public Shared Function SetupDiGetDeviceInstanceIdW(
    DeviceInfoSet As IntPtr,   ' HDEVINFO
    DeviceInfoData As IntPtr,   ' SP_DEVINFO_DATA*
    <MarshalAs(UnmanagedType.LPWStr)> DeviceInstanceId As System.Text.StringBuilder,   ' LPWSTR optional, out
    DeviceInstanceIdSize As UInteger,   ' DWORD
    RequiredSize As IntPtr   ' DWORD* optional, out
) As Boolean
End Function
' DeviceInfoSet : HDEVINFO
' DeviceInfoData : SP_DEVINFO_DATA*
' DeviceInstanceId : LPWSTR optional, out
' DeviceInstanceIdSize : DWORD
' RequiredSize : DWORD* optional, out
Declare PtrSafe Function SetupDiGetDeviceInstanceIdW Lib "setupapi" ( _
    ByVal DeviceInfoSet As LongPtr, _
    ByVal DeviceInfoData As LongPtr, _
    ByVal DeviceInstanceId As LongPtr, _
    ByVal DeviceInstanceIdSize As Long, _
    ByVal RequiredSize As LongPtr) As Long
' Unicode(W): 文字列は ByVal As LongPtr とし StrPtr(unicodeStr) を渡す
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。
import ctypes
from ctypes import wintypes

SetupDiGetDeviceInstanceIdW = ctypes.windll.setupapi.SetupDiGetDeviceInstanceIdW
SetupDiGetDeviceInstanceIdW.restype = wintypes.BOOL
SetupDiGetDeviceInstanceIdW.argtypes = [
    ctypes.c_ssize_t,  # DeviceInfoSet : HDEVINFO
    ctypes.c_void_p,  # DeviceInfoData : SP_DEVINFO_DATA*
    wintypes.LPWSTR,  # DeviceInstanceId : LPWSTR optional, out
    wintypes.DWORD,  # DeviceInstanceIdSize : DWORD
    ctypes.POINTER(wintypes.DWORD),  # RequiredSize : DWORD* optional, out
]
# GetLastError: use ctypes.GetLastError() (or ctypes.WinDLL(use_last_error=True))
require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('SETUPAPI.dll')
SetupDiGetDeviceInstanceIdW = Fiddle::Function.new(
  lib['SetupDiGetDeviceInstanceIdW'],
  [
    Fiddle::TYPE_INTPTR_T,  # DeviceInfoSet : HDEVINFO
    Fiddle::TYPE_VOIDP,  # DeviceInfoData : SP_DEVINFO_DATA*
    Fiddle::TYPE_VOIDP,  # DeviceInstanceId : LPWSTR optional, out
    -Fiddle::TYPE_INT,  # DeviceInstanceIdSize : DWORD
    Fiddle::TYPE_VOIDP,  # RequiredSize : DWORD* optional, out
  ],
  Fiddle::TYPE_INT)
# Wide strings: pass str.encode("UTF-16LE") + "\x00\x00"
#[link(name = "setupapi")]
extern "system" {
    fn SetupDiGetDeviceInstanceIdW(
        DeviceInfoSet: isize,  // HDEVINFO
        DeviceInfoData: *mut SP_DEVINFO_DATA,  // SP_DEVINFO_DATA*
        DeviceInstanceId: *mut u16,  // LPWSTR optional, out
        DeviceInstanceIdSize: u32,  // DWORD
        RequiredSize: *mut u32  // DWORD* optional, out
    ) -> i32;
}
// crates: windows-sys provides ready-made bindings for this API.
$sig = @"
[return: MarshalAs(UnmanagedType.Bool)]
[DllImport("SETUPAPI.dll", CharSet = CharSet.Unicode, SetLastError = true)]
public static extern bool SetupDiGetDeviceInstanceIdW(IntPtr DeviceInfoSet, IntPtr DeviceInfoData, [MarshalAs(UnmanagedType.LPWStr)] System.Text.StringBuilder DeviceInstanceId, uint DeviceInstanceIdSize, IntPtr RequiredSize);
"@
$api = Add-Type -MemberDefinition $sig -Name 'SETUPAPI_SetupDiGetDeviceInstanceIdW' -Namespace Win32 -PassThru
# $api::SetupDiGetDeviceInstanceIdW(DeviceInfoSet, DeviceInfoData, DeviceInstanceId, DeviceInstanceIdSize, RequiredSize)
#uselib "SETUPAPI.dll"
#func global SetupDiGetDeviceInstanceIdW "SetupDiGetDeviceInstanceIdW" wptr, wptr, wptr, wptr, wptr
; SetupDiGetDeviceInstanceIdW DeviceInfoSet, varptr(DeviceInfoData), varptr(DeviceInstanceId), DeviceInstanceIdSize, varptr(RequiredSize)   ; 戻り値は stat
; DeviceInfoSet : HDEVINFO -> "wptr"
; DeviceInfoData : SP_DEVINFO_DATA* -> "wptr"
; DeviceInstanceId : LPWSTR optional, out -> "wptr"
; DeviceInstanceIdSize : DWORD -> "wptr"
; RequiredSize : DWORD* optional, out -> "wptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。
出力引数:
#uselib "SETUPAPI.dll"
#cfunc global SetupDiGetDeviceInstanceIdW "SetupDiGetDeviceInstanceIdW" sptr, var, var, int, var
; res = SetupDiGetDeviceInstanceIdW(DeviceInfoSet, DeviceInfoData, DeviceInstanceId, DeviceInstanceIdSize, RequiredSize)
; DeviceInfoSet : HDEVINFO -> "sptr"
; DeviceInfoData : SP_DEVINFO_DATA* -> "var"
; DeviceInstanceId : LPWSTR optional, out -> "var"
; DeviceInstanceIdSize : DWORD -> "int"
; RequiredSize : DWORD* optional, out -> "var"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。
出力引数:
; BOOL SetupDiGetDeviceInstanceIdW(HDEVINFO DeviceInfoSet, SP_DEVINFO_DATA* DeviceInfoData, LPWSTR DeviceInstanceId, DWORD DeviceInstanceIdSize, DWORD* RequiredSize)
#uselib "SETUPAPI.dll"
#cfunc global SetupDiGetDeviceInstanceIdW "SetupDiGetDeviceInstanceIdW" intptr, var, var, int, var
; res = SetupDiGetDeviceInstanceIdW(DeviceInfoSet, DeviceInfoData, DeviceInstanceId, DeviceInstanceIdSize, RequiredSize)
; DeviceInfoSet : HDEVINFO -> "intptr"
; DeviceInfoData : SP_DEVINFO_DATA* -> "var"
; DeviceInstanceId : LPWSTR optional, out -> "var"
; DeviceInstanceIdSize : DWORD -> "int"
; RequiredSize : DWORD* optional, out -> "var"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。
import (
	"golang.org/x/sys/windows"
	"unsafe"
)

var (
	setupapi = windows.NewLazySystemDLL("SETUPAPI.dll")
	procSetupDiGetDeviceInstanceIdW = setupapi.NewProc("SetupDiGetDeviceInstanceIdW")
)

// DeviceInfoSet (HDEVINFO), DeviceInfoData (SP_DEVINFO_DATA*), DeviceInstanceId (LPWSTR optional, out), DeviceInstanceIdSize (DWORD), RequiredSize (DWORD* optional, out)
r1, _, err := procSetupDiGetDeviceInstanceIdW.Call(
	uintptr(DeviceInfoSet),
	uintptr(DeviceInfoData),
	uintptr(DeviceInstanceId),
	uintptr(DeviceInstanceIdSize),
	uintptr(RequiredSize),
)
_ = err  // syscall.Errno (valid when the call sets last-error)
_ = r1   // BOOL
function SetupDiGetDeviceInstanceIdW(
  DeviceInfoSet: NativeInt;   // HDEVINFO
  DeviceInfoData: Pointer;   // SP_DEVINFO_DATA*
  DeviceInstanceId: PWideChar;   // LPWSTR optional, out
  DeviceInstanceIdSize: DWORD;   // DWORD
  RequiredSize: Pointer   // DWORD* optional, out
): BOOL; stdcall;
  external 'SETUPAPI.dll' name 'SetupDiGetDeviceInstanceIdW';
result := DllCall("SETUPAPI\SetupDiGetDeviceInstanceIdW"
    , "Ptr", DeviceInfoSet   ; HDEVINFO
    , "Ptr", DeviceInfoData   ; SP_DEVINFO_DATA*
    , "Ptr", DeviceInstanceId   ; LPWSTR optional, out
    , "UInt", DeviceInstanceIdSize   ; DWORD
    , "Ptr", RequiredSize   ; DWORD* optional, out
    , "Int")   ; return: BOOL
●SetupDiGetDeviceInstanceIdW(DeviceInfoSet, DeviceInfoData, DeviceInstanceId, DeviceInstanceIdSize, RequiredSize) = DLL("SETUPAPI.dll", "bool SetupDiGetDeviceInstanceIdW(int, void*, char*, dword, void*)")
# 呼び出し: SetupDiGetDeviceInstanceIdW(DeviceInfoSet, DeviceInfoData, DeviceInstanceId, DeviceInstanceIdSize, RequiredSize)
# DeviceInfoSet : HDEVINFO -> "int"
# DeviceInfoData : SP_DEVINFO_DATA* -> "void*"
# DeviceInstanceId : LPWSTR optional, out -> "char*"
# DeviceInstanceIdSize : DWORD -> "dword"
# RequiredSize : DWORD* optional, out -> "void*"
# なでしこ1は32bit・ANSI(Shift_JIS)。文字列=char*(ANSI)、ポインタ/ハンドル=void*(4byte)。
# ※-W(Unicode)関数。なでしこ1はANSIのため -A 版の利用を推奨。