ホーム › Devices.DeviceAndDriverInstallation › SetupDiInstallDeviceInterfaces

SetupDiInstallDeviceInterfaces

関数

デバイスのインターフェイスをインストールする。

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

シグネチャ

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

BOOL SetupDiInstallDeviceInterfaces(
    HDEVINFO DeviceInfoSet,
    SP_DEVINFO_DATA* DeviceInfoData
);

パラメーター

名前	型	方向	説明
DeviceInfoSet	HDEVINFO	in	インターフェイスをインストールする対象のデバイスを表すデバイス情報要素を含むデバイス情報セットへのポインター。デバイス情報セットには、ローカルシステムの要素のみが含まれている必要があります。
DeviceInfoData	SP_DEVINFO_DATA*	in	DeviceInfoSet 内のデバイス情報要素を指定する SP_DEVINFO_DATA 構造体へのポインター。

戻り値の型: BOOL

公式ドキュメント

SetupDiInstallDeviceInterfaces 関数は、DIF_INSTALLINTERFACES インストール要求に対する既定のハンドラーです。

戻り値

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

解説(Remarks)

SetupDiInstallDeviceInterfaces は、デバイス INF ファイルの DDInstall.Interfaces セクションにある各 AddInterface エントリを処理し、SetupDiCreateDeviceInterface を呼び出して各インターフェイスを作成します。

SetupDiInstallDeviceInterfaces の呼び出し元は、Administrators グループのメンバーである必要があります。

メモ SetupDiInstallDeviceInterfaces を呼び出してよいのはクラスインストーラーのみであり、しかも SetupDiInstallDeviceInterfaces が既定のデバイスインターフェイスインストール操作を完了した後に、クラスインストーラーがデバイスインターフェイスのインストール操作を実行しなければならない場合に限られます。そのような場合、クラスインストーラーは DIF_INSTALLINTERFACES 要求を処理する際に SetupDiInstallDeviceInterfaces を直接呼び出す必要があります。既定のハンドラーの呼び出しの詳細については、「Calling Default DIF Code Handlers」を参照してください。

INF ファイルの形式については、「INF File Sections and Directives」を参照してください。

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

各言語での呼び出し定義

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

BOOL SetupDiInstallDeviceInterfaces(
    HDEVINFO DeviceInfoSet,
    SP_DEVINFO_DATA* DeviceInfoData
);

[return: MarshalAs(UnmanagedType.Bool)]
[DllImport("SETUPAPI.dll", SetLastError = true, ExactSpelling = true)]
static extern bool SetupDiInstallDeviceInterfaces(
    IntPtr DeviceInfoSet,   // HDEVINFO
    IntPtr DeviceInfoData   // SP_DEVINFO_DATA*
);

<DllImport("SETUPAPI.dll", SetLastError:=True, ExactSpelling:=True)>
Public Shared Function SetupDiInstallDeviceInterfaces(
    DeviceInfoSet As IntPtr,   ' HDEVINFO
    DeviceInfoData As IntPtr   ' SP_DEVINFO_DATA*
) As <MarshalAs(UnmanagedType.Bool)> Boolean
End Function

' DeviceInfoSet : HDEVINFO
' DeviceInfoData : SP_DEVINFO_DATA*
Declare PtrSafe Function SetupDiInstallDeviceInterfaces Lib "setupapi" ( _
    ByVal DeviceInfoSet As LongPtr, _
    ByVal DeviceInfoData As LongPtr) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。

import ctypes
from ctypes import wintypes

SetupDiInstallDeviceInterfaces = ctypes.windll.setupapi.SetupDiInstallDeviceInterfaces
SetupDiInstallDeviceInterfaces.restype = wintypes.BOOL
SetupDiInstallDeviceInterfaces.argtypes = [
    ctypes.c_ssize_t,  # DeviceInfoSet : HDEVINFO
    ctypes.c_void_p,  # DeviceInfoData : SP_DEVINFO_DATA*
]
# GetLastError: use ctypes.GetLastError() (or ctypes.WinDLL(use_last_error=True))

require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('SETUPAPI.dll')
SetupDiInstallDeviceInterfaces = Fiddle::Function.new(
  lib['SetupDiInstallDeviceInterfaces'],
  [
    Fiddle::TYPE_INTPTR_T,  # DeviceInfoSet : HDEVINFO
    Fiddle::TYPE_VOIDP,  # DeviceInfoData : SP_DEVINFO_DATA*
  ],
  Fiddle::TYPE_INT)

#[link(name = "setupapi")]
extern "system" {
    fn SetupDiInstallDeviceInterfaces(
        DeviceInfoSet: isize,  // HDEVINFO
        DeviceInfoData: *mut SP_DEVINFO_DATA  // SP_DEVINFO_DATA*
    ) -> 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 SetupDiInstallDeviceInterfaces(IntPtr DeviceInfoSet, IntPtr DeviceInfoData);
"@
$api = Add-Type -MemberDefinition $sig -Name 'SETUPAPI_SetupDiInstallDeviceInterfaces' -Namespace Win32 -PassThru
# $api::SetupDiInstallDeviceInterfaces(DeviceInfoSet, DeviceInfoData)

#uselib "SETUPAPI.dll"
#func global SetupDiInstallDeviceInterfaces "SetupDiInstallDeviceInterfaces" sptr, sptr
; SetupDiInstallDeviceInterfaces DeviceInfoSet, varptr(DeviceInfoData)   ; 戻り値は stat
; DeviceInfoSet : HDEVINFO -> "sptr"
; DeviceInfoData : SP_DEVINFO_DATA* -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。

出力引数:

#uselib "SETUPAPI.dll"
#cfunc global SetupDiInstallDeviceInterfaces "SetupDiInstallDeviceInterfaces" sptr, var
; res = SetupDiInstallDeviceInterfaces(DeviceInfoSet, DeviceInfoData)
; DeviceInfoSet : HDEVINFO -> "sptr"
; DeviceInfoData : SP_DEVINFO_DATA* -> "var"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。#uselib "SETUPAPI.dll"
#cfunc global SetupDiInstallDeviceInterfaces "SetupDiInstallDeviceInterfaces" sptr, sptr
; res = SetupDiInstallDeviceInterfaces(DeviceInfoSet, varptr(DeviceInfoData))
; DeviceInfoSet : HDEVINFO -> "sptr"
; DeviceInfoData : SP_DEVINFO_DATA* -> "sptr"
; ※出力/バッファ引数はポインタ方式(token=sptr / 呼び出しは varptr(変数))。