ホーム › Devices.DeviceAndDriverInstallation › SetupDiOpenDeviceInterfaceA

SetupDiOpenDeviceInterfaceA

関数

デバイスパスを指定してデバイスインターフェイスを開く。

DLLSETUPAPI.dll文字セットANSI (-A)呼出規約winapiSetLastErrorあり対応OSWindows 2000 以降

シグネチャ

// SETUPAPI.dll  (ANSI / -A)
#include <windows.h>

BOOL SetupDiOpenDeviceInterfaceA(
    HDEVINFO DeviceInfoSet,
    LPCSTR DevicePath,
    DWORD OpenFlags,
    SP_DEVICE_INTERFACE_DATA* DeviceInterfaceData   // optional
);

パラメーター

名前	型	方向	説明
DeviceInfoSet	HDEVINFO	in	開くインターフェイスをサポートするデバイスを表すデバイス情報要素を含む、または今後含むことになるデバイス情報セットへのポインターです。
DevicePath	LPCSTR	in	開くデバイスインターフェイスの名前を指定する、NULL で終わる文字列へのポインターです。この名前は Win32 デバイスパスであり、通常は PnP 通知構造体で受け取るか、SetupDiEnumDeviceInterfaces やその関連関数の以前の呼び出しによって取得します。
OpenFlags	DWORD	in	デバイスインターフェイス要素をどのように開くかを決定するフラグです。有効なフラグは次の 1 つだけです。 DIODI_NO_ADD 対象となるデバイスのデバイス情報要素が、指定したデバイス情報セットにまだ存在しない場合に、その要素を作成しないことを指定します。詳細については、後述の解説のセクションを参照してください。
DeviceInterfaceData	SP_DEVICE_INTERFACE_DATA*	inoutoptional	要求されたインターフェイスデータを受け取る、呼び出し元が初期化した SP_DEVICE_INTERFACE_DATA 構造体へのポインターです。このポインターは省略可能で、NULL を指定できます。バッファーを指定する場合、呼び出し元は SetupDiOpenDeviceInterface を呼び出す前に、構造体の cbSize メンバーに sizeof(SP_DEVICE_INTERFACE_DATA) を設定する必要があります。詳細については、後述の解説のセクションを参照してください。

戻り値の型: BOOL

公式ドキュメント

SetupDiOpenDeviceInterface 関数は、デバイスインターフェイスに関する情報を取得し、そのインターフェイスを、ローカルシステムまたはリモートシステムの指定されたデバイス情報セットに追加します。(ANSI)

戻り値

SetupDiOpenDeviceInterface は、関数がエラーなく完了した場合に TRUE を返します。関数がエラーで終了した場合は FALSE を返し、失敗の原因を示すエラーコードは GetLastError を呼び出して取得できます。

解説(Remarks)

そのインターフェイスに対応するデバイスインターフェイス要素が DeviceInfoSet に既に存在する場合、SetupDiOpenDeviceInterface はフラグを更新します。したがって、この関数はデバイスインターフェイスのフラグを更新する目的にも使用できます。たとえば、最初に開いたときには非アクティブだったインターフェイスが、その後アクティブになった場合などです。対象となるデバイスのデバイス情報要素が DeviceInfoSet にまだ存在しない場合、この関数はそれを作成して DeviceInfoSet に追加します。

関数が新しいデバイスインターフェイスを正常に開いたにもかかわらず、呼び出し元が DeviceInterfaceData パラメーターに有効な構造体を指定しなかった場合、関数は FALSE を返し、続けて GetLastError を呼び出すと ERROR_INVALID_USER_BUFFER が返されます。ただしこの場合でも、SetupDiOpenDeviceInterface は要求されたインターフェイスをデバイス情報セットに追加します。

新しいデバイスインターフェイスは正常に開かれたが、呼び出し元が指定した DeviceInterfaceData バッファーが無効である場合、この関数は FALSE を返し、GetLastError は ERROR_INVALID_USER_BUFFER を返します。呼び出し元のバッファーのエラーは、インターフェイスが開かれることを妨げません。

OpenFlags パラメーターに DIODI_NO_ADD フラグが指定され、かつ対象となるデバイスのデバイス情報要素が、指定したデバイス情報セットにまだ存在しない場合、この関数は FALSE を返し、GetLastError は ERROR_NO_SUCH_DEVICE_INTERFACE を返します。

アプリケーションは、SetupDiOpenDeviceInterface が取得した情報の使用を終えたとき、SetupDiDeleteDeviceInterfaceData を呼び出す必要があります。

SetupDiOpenDeviceInterface 関数の DevicePath 引数の値として、MF_DEVSOURCE_ATTRIBUTE_SOURCE_TYPE_VIDCAP_SYMBOLIC_LINK 属性を渡すことができます。

メモ

setupapi.h ヘッダーは、UNICODE プリプロセッサ定数の定義に基づいて、この関数の ANSI 版または Unicode 版を自動的に選択するエイリアスとして SetupDiOpenDeviceInterface を定義します。エンコーディングに依存しないエイリアスの使用と、エンコーディングに依存するコードを混在させると、不一致が生じ、コンパイルエラーや実行時エラーの原因となる場合があります。詳細については、関数プロトタイプの規則を参照してください。

出典・ライセンス: 上記「公式ドキュメント」の内容は Microsoft の Win32 API ドキュメント(MicrosoftDocs/sdk-api)を日本語に翻訳・改変したものです。© Microsoft Corporation. CC BY 4.0 で提供。
Microsoft 公式リファレンス: 英語 (en-us) · 日本語 (ja-jp) · 原文ソース (GitHub)

各言語での呼び出し定義

// SETUPAPI.dll  (ANSI / -A)
#include <windows.h>

BOOL SetupDiOpenDeviceInterfaceA(
    HDEVINFO DeviceInfoSet,
    LPCSTR DevicePath,
    DWORD OpenFlags,
    SP_DEVICE_INTERFACE_DATA* DeviceInterfaceData   // optional
);

[return: MarshalAs(UnmanagedType.Bool)]
[DllImport("SETUPAPI.dll", CharSet = CharSet.Ansi, SetLastError = true, ExactSpelling = true)]
static extern bool SetupDiOpenDeviceInterfaceA(
    IntPtr DeviceInfoSet,   // HDEVINFO
    [MarshalAs(UnmanagedType.LPStr)] string DevicePath,   // LPCSTR
    uint OpenFlags,   // DWORD
    IntPtr DeviceInterfaceData   // SP_DEVICE_INTERFACE_DATA* optional, in/out
);

<DllImport("SETUPAPI.dll", CharSet:=CharSet.Ansi, SetLastError:=True, ExactSpelling:=True)>
Public Shared Function SetupDiOpenDeviceInterfaceA(
    DeviceInfoSet As IntPtr,   ' HDEVINFO
    <MarshalAs(UnmanagedType.LPStr)> DevicePath As String,   ' LPCSTR
    OpenFlags As UInteger,   ' DWORD
    DeviceInterfaceData As IntPtr   ' SP_DEVICE_INTERFACE_DATA* optional, in/out
) As <MarshalAs(UnmanagedType.Bool)> Boolean
End Function

' DeviceInfoSet : HDEVINFO
' DevicePath : LPCSTR
' OpenFlags : DWORD
' DeviceInterfaceData : SP_DEVICE_INTERFACE_DATA* optional, in/out
Declare PtrSafe Function SetupDiOpenDeviceInterfaceA Lib "setupapi" ( _
    ByVal DeviceInfoSet As LongPtr, _
    ByVal DevicePath As String, _
    ByVal OpenFlags As Long, _
    ByVal DeviceInterfaceData As LongPtr) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。

import ctypes
from ctypes import wintypes

SetupDiOpenDeviceInterfaceA = ctypes.windll.setupapi.SetupDiOpenDeviceInterfaceA
SetupDiOpenDeviceInterfaceA.restype = wintypes.BOOL
SetupDiOpenDeviceInterfaceA.argtypes = [
    ctypes.c_ssize_t,  # DeviceInfoSet : HDEVINFO
    wintypes.LPCSTR,  # DevicePath : LPCSTR
    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')
SetupDiOpenDeviceInterfaceA = Fiddle::Function.new(
  lib['SetupDiOpenDeviceInterfaceA'],
  [
    Fiddle::TYPE_INTPTR_T,  # DeviceInfoSet : HDEVINFO
    Fiddle::TYPE_VOIDP,  # DevicePath : LPCSTR
    -Fiddle::TYPE_INT,  # OpenFlags : DWORD
    Fiddle::TYPE_VOIDP,  # DeviceInterfaceData : SP_DEVICE_INTERFACE_DATA* optional, in/out
  ],
  Fiddle::TYPE_INT)

#[link(name = "setupapi")]
extern "system" {
    fn SetupDiOpenDeviceInterfaceA(
        DeviceInfoSet: isize,  // HDEVINFO
        DevicePath: *const u8,  // LPCSTR
        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.Ansi, SetLastError = true)]
public static extern bool SetupDiOpenDeviceInterfaceA(IntPtr DeviceInfoSet, [MarshalAs(UnmanagedType.LPStr)] string DevicePath, uint OpenFlags, IntPtr DeviceInterfaceData);
"@
$api = Add-Type -MemberDefinition $sig -Name 'SETUPAPI_SetupDiOpenDeviceInterfaceA' -Namespace Win32 -PassThru
# $api::SetupDiOpenDeviceInterfaceA(DeviceInfoSet, DevicePath, OpenFlags, DeviceInterfaceData)

#uselib "SETUPAPI.dll"
#func global SetupDiOpenDeviceInterfaceA "SetupDiOpenDeviceInterfaceA" sptr, sptr, sptr, sptr
; SetupDiOpenDeviceInterfaceA DeviceInfoSet, DevicePath, OpenFlags, varptr(DeviceInterfaceData)   ; 戻り値は stat
; DeviceInfoSet : HDEVINFO -> "sptr"
; DevicePath : LPCSTR -> "sptr"
; OpenFlags : DWORD -> "sptr"
; DeviceInterfaceData : SP_DEVICE_INTERFACE_DATA* optional, in/out -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。

出力引数:

#uselib "SETUPAPI.dll"
#cfunc global SetupDiOpenDeviceInterfaceA "SetupDiOpenDeviceInterfaceA" sptr, str, int, var
; res = SetupDiOpenDeviceInterfaceA(DeviceInfoSet, DevicePath, OpenFlags, DeviceInterfaceData)
; DeviceInfoSet : HDEVINFO -> "sptr"
; DevicePath : LPCSTR -> "str"
; OpenFlags : DWORD -> "int"
; DeviceInterfaceData : SP_DEVICE_INTERFACE_DATA* optional, in/out -> "var"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。#uselib "SETUPAPI.dll"
#cfunc global SetupDiOpenDeviceInterfaceA "SetupDiOpenDeviceInterfaceA" sptr, str, int, sptr
; res = SetupDiOpenDeviceInterfaceA(DeviceInfoSet, DevicePath, OpenFlags, varptr(DeviceInterfaceData))
; DeviceInfoSet : HDEVINFO -> "sptr"
; DevicePath : LPCSTR -> "str"
; OpenFlags : DWORD -> "int"
; DeviceInterfaceData : SP_DEVICE_INTERFACE_DATA* optional, in/out -> "sptr"
; ※出力/バッファ引数はポインタ方式(token=sptr / 呼び出しは varptr(変数))。