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

SetupDiOpenDeviceInterfaceW

関数
デバイスパスを指定してデバイスインターフェイスを開く。
DLLSETUPAPI.dll文字セットUnicode (-W)呼出規約winapiSetLastErrorあり対応OSWindows 2000 以降

シグネチャ

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

BOOL SetupDiOpenDeviceInterfaceW(
    HDEVINFO DeviceInfoSet,
    LPCWSTR DevicePath,
    DWORD OpenFlags,
    SP_DEVICE_INTERFACE_DATA* DeviceInterfaceData   // optional
);

パラメーター

名前方向説明
DeviceInfoSetHDEVINFOinインターフェイス要素を追加する対象のデバイス情報セット。
DevicePathLPCWSTRin開くデバイスインターフェイスのデバイスパス(Unicode)。
OpenFlagsDWORDinオープン動作を制御するフラグ。通常は0。
DeviceInterfaceDataSP_DEVICE_INTERFACE_DATA*inoutoptional開いたインターフェイス情報を受け取るSP_DEVICE_INTERFACE_DATAへのポインタ(出力)。NULL可。

戻り値の型: BOOL

各言語での呼び出し定義

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

BOOL SetupDiOpenDeviceInterfaceW(
    HDEVINFO DeviceInfoSet,
    LPCWSTR DevicePath,
    DWORD OpenFlags,
    SP_DEVICE_INTERFACE_DATA* DeviceInterfaceData   // optional
);
[return: MarshalAs(UnmanagedType.Bool)]
[DllImport("SETUPAPI.dll", CharSet = CharSet.Unicode, SetLastError = true, ExactSpelling = true)]
static extern bool SetupDiOpenDeviceInterfaceW(
    IntPtr DeviceInfoSet,   // HDEVINFO
    [MarshalAs(UnmanagedType.LPWStr)] string DevicePath,   // LPCWSTR
    uint OpenFlags,   // DWORD
    IntPtr DeviceInterfaceData   // SP_DEVICE_INTERFACE_DATA* optional, in/out
);
<DllImport("SETUPAPI.dll", CharSet:=CharSet.Unicode, SetLastError:=True, ExactSpelling:=True)>
Public Shared Function SetupDiOpenDeviceInterfaceW(
    DeviceInfoSet As IntPtr,   ' HDEVINFO
    <MarshalAs(UnmanagedType.LPWStr)> DevicePath As String,   ' LPCWSTR
    OpenFlags As UInteger,   ' DWORD
    DeviceInterfaceData As IntPtr   ' SP_DEVICE_INTERFACE_DATA* optional, in/out
) As <MarshalAs(UnmanagedType.Bool)> Boolean
End Function
' DeviceInfoSet : HDEVINFO
' DevicePath : LPCWSTR
' OpenFlags : DWORD
' DeviceInterfaceData : SP_DEVICE_INTERFACE_DATA* optional, in/out
Declare PtrSafe Function SetupDiOpenDeviceInterfaceW Lib "setupapi" ( _
    ByVal DeviceInfoSet As LongPtr, _
    ByVal DevicePath As LongPtr, _
    ByVal OpenFlags As Long, _
    ByVal DeviceInterfaceData 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

SetupDiOpenDeviceInterfaceW = ctypes.windll.setupapi.SetupDiOpenDeviceInterfaceW
SetupDiOpenDeviceInterfaceW.restype = wintypes.BOOL
SetupDiOpenDeviceInterfaceW.argtypes = [
    ctypes.c_ssize_t,  # DeviceInfoSet : HDEVINFO
    wintypes.LPCWSTR,  # DevicePath : LPCWSTR
    wintypes.DWORD,  # OpenFlags : DWORD
    ctypes.c_void_p,  # DeviceInterfaceData : SP_DEVICE_INTERFACE_DATA* optional, in/out
]
# GetLastError: use ctypes.GetLastError() (or ctypes.WinDLL(use_last_error=True))
require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('SETUPAPI.dll')
SetupDiOpenDeviceInterfaceW = Fiddle::Function.new(
  lib['SetupDiOpenDeviceInterfaceW'],
  [
    Fiddle::TYPE_INTPTR_T,  # DeviceInfoSet : HDEVINFO
    Fiddle::TYPE_VOIDP,  # DevicePath : LPCWSTR
    -Fiddle::TYPE_INT,  # OpenFlags : DWORD
    Fiddle::TYPE_VOIDP,  # DeviceInterfaceData : SP_DEVICE_INTERFACE_DATA* optional, in/out
  ],
  Fiddle::TYPE_INT)
# Wide strings: pass str.encode("UTF-16LE") + "\x00\x00"
#[link(name = "setupapi")]
extern "system" {
    fn SetupDiOpenDeviceInterfaceW(
        DeviceInfoSet: isize,  // HDEVINFO
        DevicePath: *const u16,  // LPCWSTR
        OpenFlags: u32,  // DWORD
        DeviceInterfaceData: *mut SP_DEVICE_INTERFACE_DATA  // SP_DEVICE_INTERFACE_DATA* optional, in/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 SetupDiOpenDeviceInterfaceW(IntPtr DeviceInfoSet, [MarshalAs(UnmanagedType.LPWStr)] string DevicePath, uint OpenFlags, IntPtr DeviceInterfaceData);
"@
$api = Add-Type -MemberDefinition $sig -Name 'SETUPAPI_SetupDiOpenDeviceInterfaceW' -Namespace Win32 -PassThru
# $api::SetupDiOpenDeviceInterfaceW(DeviceInfoSet, DevicePath, OpenFlags, DeviceInterfaceData)
#uselib "SETUPAPI.dll"
#func global SetupDiOpenDeviceInterfaceW "SetupDiOpenDeviceInterfaceW" wptr, wptr, wptr, wptr
; SetupDiOpenDeviceInterfaceW DeviceInfoSet, DevicePath, OpenFlags, varptr(DeviceInterfaceData)   ; 戻り値は stat
; DeviceInfoSet : HDEVINFO -> "wptr"
; DevicePath : LPCWSTR -> "wptr"
; OpenFlags : DWORD -> "wptr"
; DeviceInterfaceData : SP_DEVICE_INTERFACE_DATA* optional, in/out -> "wptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。
出力引数:
#uselib "SETUPAPI.dll"
#cfunc global SetupDiOpenDeviceInterfaceW "SetupDiOpenDeviceInterfaceW" sptr, wstr, int, var
; res = SetupDiOpenDeviceInterfaceW(DeviceInfoSet, DevicePath, OpenFlags, DeviceInterfaceData)
; DeviceInfoSet : HDEVINFO -> "sptr"
; DevicePath : LPCWSTR -> "wstr"
; OpenFlags : DWORD -> "int"
; DeviceInterfaceData : SP_DEVICE_INTERFACE_DATA* optional, in/out -> "var"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。
出力引数:
; BOOL SetupDiOpenDeviceInterfaceW(HDEVINFO DeviceInfoSet, LPCWSTR DevicePath, DWORD OpenFlags, SP_DEVICE_INTERFACE_DATA* DeviceInterfaceData)
#uselib "SETUPAPI.dll"
#cfunc global SetupDiOpenDeviceInterfaceW "SetupDiOpenDeviceInterfaceW" intptr, wstr, int, var
; res = SetupDiOpenDeviceInterfaceW(DeviceInfoSet, DevicePath, OpenFlags, DeviceInterfaceData)
; DeviceInfoSet : HDEVINFO -> "intptr"
; DevicePath : LPCWSTR -> "wstr"
; OpenFlags : DWORD -> "int"
; DeviceInterfaceData : SP_DEVICE_INTERFACE_DATA* optional, in/out -> "var"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。
import (
	"golang.org/x/sys/windows"
	"unsafe"
)

var (
	setupapi = windows.NewLazySystemDLL("SETUPAPI.dll")
	procSetupDiOpenDeviceInterfaceW = setupapi.NewProc("SetupDiOpenDeviceInterfaceW")
)

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

extern "setupapi" fn SetupDiOpenDeviceInterfaceW(
    DeviceInfoSet: isize, // HDEVINFO
    DevicePath: [*c]const u16, // LPCWSTR
    OpenFlags: u32, // DWORD
    DeviceInterfaceData: [*c]SP_DEVICE_INTERFACE_DATA // SP_DEVICE_INTERFACE_DATA* optional, in/out
) callconv(std.os.windows.WINAPI) i32;
// Unicode(-W): UTF-16LE のヌル終端バッファ([*c]const u16)を渡す。
proc SetupDiOpenDeviceInterfaceW(
    DeviceInfoSet: int,  # HDEVINFO
    DevicePath: WideCString,  # LPCWSTR
    OpenFlags: uint32,  # DWORD
    DeviceInterfaceData: ptr SP_DEVICE_INTERFACE_DATA  # SP_DEVICE_INTERFACE_DATA* optional, in/out
): int32 {.importc: "SetupDiOpenDeviceInterfaceW", stdcall, dynlib: "SETUPAPI.dll".}
# Unicode(-W): WideCString は newWideCString("...") で生成。
pragma(lib, "setupapi");
extern(Windows)
int SetupDiOpenDeviceInterfaceW(
    ptrdiff_t DeviceInfoSet,   // HDEVINFO
    const(wchar)* DevicePath,   // LPCWSTR
    uint OpenFlags,   // DWORD
    SP_DEVICE_INTERFACE_DATA* DeviceInterfaceData   // SP_DEVICE_INTERFACE_DATA* optional, in/out
);
ccall((:SetupDiOpenDeviceInterfaceW, "SETUPAPI.dll"), stdcall, Int32,
      (Int, Cwstring, UInt32, Ptr{SP_DEVICE_INTERFACE_DATA}),
      DeviceInfoSet, DevicePath, OpenFlags, DeviceInterfaceData)
# DeviceInfoSet : HDEVINFO -> Int
# DevicePath : LPCWSTR -> Cwstring
# OpenFlags : DWORD -> UInt32
# DeviceInterfaceData : SP_DEVICE_INTERFACE_DATA* optional, in/out -> Ptr{SP_DEVICE_INTERFACE_DATA}
# stdcall は 32bit のみ意味を持つ(x64 では無視)。
# Unicode(-W): Cwstring には transcode(UInt16, "...") 等で UTF-16 を渡す。
local ffi = require("ffi")
ffi.cdef[[
int32_t SetupDiOpenDeviceInterfaceW(
    intptr_t DeviceInfoSet,
    const uint16_t* DevicePath,
    uint32_t OpenFlags,
    void* DeviceInterfaceData);
]]
local setupapi = ffi.load("setupapi")
-- setupapi.SetupDiOpenDeviceInterfaceW(DeviceInfoSet, DevicePath, OpenFlags, DeviceInterfaceData)
-- DeviceInfoSet : HDEVINFO
-- DevicePath : LPCWSTR
-- OpenFlags : DWORD
-- DeviceInterfaceData : SP_DEVICE_INTERFACE_DATA* optional, in/out
-- 構造体/GUIDへのポインタは cdef が通るよう void* で表記(実型は各引数コメント参照)。値渡し構造体・enum は対応する typedef を cdef に追加すること。
-- Unicode(-W): uint16_t* には UTF-16LE のバッファ(ffi.new("uint16_t[?]", ...))を渡す。
const koffi = require('koffi');
const lib = koffi.load('SETUPAPI.dll');
const SetupDiOpenDeviceInterfaceW = lib.func('__stdcall', 'SetupDiOpenDeviceInterfaceW', 'int32_t', ['intptr_t', 'str16', 'uint32_t', 'void *']);
// SetupDiOpenDeviceInterfaceW(DeviceInfoSet, DevicePath, OpenFlags, DeviceInterfaceData)
// DeviceInfoSet : HDEVINFO -> 'intptr_t'
// DevicePath : LPCWSTR -> 'str16'
// OpenFlags : DWORD -> 'uint32_t'
// DeviceInterfaceData : SP_DEVICE_INTERFACE_DATA* optional, in/out -> 'void *'
// 出力ポインタは koffi.out(...) で包む。構造体は koffi.struct で定義。
const lib = Deno.dlopen("SETUPAPI.dll", {
  SetupDiOpenDeviceInterfaceW: { parameters: ["isize", "buffer", "u32", "pointer"], result: "i32" },
});
// lib.symbols.SetupDiOpenDeviceInterfaceW(DeviceInfoSet, DevicePath, OpenFlags, DeviceInterfaceData)
// DeviceInfoSet : HDEVINFO -> "isize"
// DevicePath : LPCWSTR -> "buffer"
// OpenFlags : DWORD -> "u32"
// DeviceInterfaceData : SP_DEVICE_INTERFACE_DATA* optional, in/out -> "pointer"
// 文字列は "buffer"。Unicode(-W) は new TextEncoder() ではなく UTF-16LE のバイト列(末尾に \x00\x00)を Uint8Array で渡す。
// 値渡し構造体は { struct: [ ...field types... ] } を使用。
<?php
$ffi = FFI::cdef(<<<C
int32_t SetupDiOpenDeviceInterfaceW(
    intptr_t DeviceInfoSet,
    const uint16_t* DevicePath,
    uint32_t OpenFlags,
    void* DeviceInterfaceData);
C, "SETUPAPI.dll");
// $ffi->SetupDiOpenDeviceInterfaceW(DeviceInfoSet, DevicePath, OpenFlags, DeviceInterfaceData);
// DeviceInfoSet : HDEVINFO
// DevicePath : LPCWSTR
// OpenFlags : DWORD
// DeviceInterfaceData : SP_DEVICE_INTERFACE_DATA* optional, in/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 Setupapi extends StdCallLibrary {
    Setupapi INSTANCE = Native.load("setupapi", Setupapi.class, W32APIOptions.UNICODE_OPTIONS);
    boolean SetupDiOpenDeviceInterfaceW(
        long DeviceInfoSet,   // HDEVINFO
        WString DevicePath,   // LPCWSTR
        int OpenFlags,   // DWORD
        Pointer DeviceInterfaceData   // SP_DEVICE_INTERFACE_DATA* optional, in/out
    );
}
// Unicode(-W): WString(入力)/char[](出力)で UTF-16 をマーシャリング。
@[Link("setupapi")]
lib LibSETUPAPI
  fun SetupDiOpenDeviceInterfaceW = SetupDiOpenDeviceInterfaceW(
    DeviceInfoSet : LibC::SSizeT,   # HDEVINFO
    DevicePath : UInt16*,   # LPCWSTR
    OpenFlags : UInt32,   # DWORD
    DeviceInterfaceData : SP_DEVICE_INTERFACE_DATA*   # SP_DEVICE_INTERFACE_DATA* optional, in/out
  ) : Int32
end
# 構造体/GUID/enum は lib 内に対応する型定義が必要。
# 呼出規約: x64 は規約統一のため OK。x86(32bit)は WINAPI=stdcall だが Crystal の fun に stdcall 付与構文がなく非対応。
import 'dart:ffi';
import 'package:ffi/ffi.dart';

typedef SetupDiOpenDeviceInterfaceWNative = Int32 Function(IntPtr, Pointer<Utf16>, Uint32, Pointer<Void>);
typedef SetupDiOpenDeviceInterfaceWDart = int Function(int, Pointer<Utf16>, int, Pointer<Void>);
final SetupDiOpenDeviceInterfaceW = DynamicLibrary.open('SETUPAPI.dll')
    .lookupFunction<SetupDiOpenDeviceInterfaceWNative, SetupDiOpenDeviceInterfaceWDart>('SetupDiOpenDeviceInterfaceW');
// DeviceInfoSet : HDEVINFO -> IntPtr
// DevicePath : LPCWSTR -> Pointer<Utf16>
// OpenFlags : DWORD -> Uint32
// DeviceInterfaceData : SP_DEVICE_INTERFACE_DATA* optional, in/out -> Pointer<Void>
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。
{$mode objfpc}{$H+}
function SetupDiOpenDeviceInterfaceW(
  DeviceInfoSet: NativeInt;   // HDEVINFO
  DevicePath: PWideChar;   // LPCWSTR
  OpenFlags: DWORD;   // DWORD
  DeviceInterfaceData: Pointer   // SP_DEVICE_INTERFACE_DATA* optional, in/out
): BOOL; stdcall;
  external 'SETUPAPI.dll' name 'SetupDiOpenDeviceInterfaceW';
import Foreign
import Foreign.C.Types
import Foreign.C.String

foreign import stdcall safe "SetupDiOpenDeviceInterfaceW"
  c_SetupDiOpenDeviceInterfaceW :: CIntPtr -> CWString -> Word32 -> Ptr () -> IO CInt
-- DeviceInfoSet : HDEVINFO -> CIntPtr
-- DevicePath : LPCWSTR -> CWString
-- OpenFlags : DWORD -> Word32
-- DeviceInterfaceData : SP_DEVICE_INTERFACE_DATA* optional, in/out -> Ptr ()
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。
open Ctypes
open Foreign

let setupdiopendeviceinterfacew =
  foreign "SetupDiOpenDeviceInterfaceW"
    (intptr_t @-> (ptr uint16_t) @-> uint32_t @-> (ptr void) @-> returning int32_t)
(* DeviceInfoSet : HDEVINFO -> intptr_t *)
(* DevicePath : LPCWSTR -> (ptr uint16_t) *)
(* OpenFlags : DWORD -> uint32_t *)
(* DeviceInterfaceData : SP_DEVICE_INTERFACE_DATA* optional, in/out -> (ptr void) *)
(* foreign は cdecl 前提。x64 Windows では WINAPI と一致。構造体は ctypes structure を定義のこと。 *)
(cffi:define-foreign-library setupapi (t "SETUPAPI.dll"))
(cffi:use-foreign-library setupapi)

(cffi:defcfun ("SetupDiOpenDeviceInterfaceW" setup-di-open-device-interface-w :convention :stdcall) :int32
  (device-info-set :int64)   ; HDEVINFO
  (device-path (:string :encoding :utf-16le))   ; LPCWSTR
  (open-flags :uint32)   ; DWORD
  (device-interface-data :pointer))   ; SP_DEVICE_INTERFACE_DATA* optional, in/out
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。
use Win32::API;
my $SetupDiOpenDeviceInterfaceW = Win32::API::More->new('SETUPAPI',
    'BOOL SetupDiOpenDeviceInterfaceW(LPARAM DeviceInfoSet, LPCWSTR DevicePath, DWORD OpenFlags, LPVOID DeviceInterfaceData)');
# my $ret = $SetupDiOpenDeviceInterfaceW->Call($DeviceInfoSet, $DevicePath, $OpenFlags, $DeviceInterfaceData);
# DeviceInfoSet : HDEVINFO -> LPARAM
# DevicePath : LPCWSTR -> LPCWSTR
# OpenFlags : DWORD -> DWORD
# DeviceInterfaceData : SP_DEVICE_INTERFACE_DATA* optional, in/out -> LPVOID
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。
# Unicode(-W): LPCWSTR/LPWSTR は Win32::API が UTF-16 変換を行う。

関連項目

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