ホーム › Devices.DeviceAndDriverInstallation › SetupDiBuildDriverInfoList

SetupDiBuildDriverInfoList

関数

デバイスに対する互換ドライバの一覧を構築する。

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

シグネチャ

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

BOOL SetupDiBuildDriverInfoList(
    HDEVINFO DeviceInfoSet,
    SP_DEVINFO_DATA* DeviceInfoData,   // optional
    SETUP_DI_DRIVER_TYPE DriverType
);

パラメーター

名前

型

方向

説明

DeviceInfoSet

HDEVINFO

ドライバー一覧を格納するデバイス情報セットへのハンドル。一覧は、すべてのデバイス情報要素に対してグローバルに、または単一のデバイス情報要素に対して個別に格納されます。デバイス情報セットに、リモートのデバイス情報要素が含まれていてはなりません。

DeviceInfoData

SP_DEVINFO_DATA*

inoutoptional

ドライバー一覧を構築する対象のデバイスを表す、DeviceInfoSet 内のデバイス情報要素の SP_DEVINFO_DATA 構造体へのポインター。このパラメーターは省略可能で、NULL を指定できます。このパラメーターを指定した場合、一覧は指定したデバイスに関連付けられます。このパラメーターが NULL の場合、一覧は DeviceInfoSet のグローバルクラスドライバー一覧に関連付けられます。

互換ドライバー一覧の構築によってこのデバイスのクラスが更新された場合、DeviceInfoData.ClassGuid は戻り時に更新されます。

DriverType

SETUP_DI_DRIVER_TYPE

構築するドライバー一覧の種類。次のいずれかの値を指定する必要があります。

値	意味
SPDIT_CLASSDRIVER	クラスドライバーの一覧を構築します。DeviceInfoData が NULL の場合は、このドライバー一覧の種類を指定する必要があります。
SPDIT_COMPATDRIVER	互換ドライバーの一覧を構築します。このドライバー一覧の種類を指定する場合、DeviceInfoData を NULL にすることはできません。

戻り値の型: BOOL

公式ドキュメント

SetupDiBuildDriverInfoList 関数は、特定のデバイスに関連付けられたドライバーの一覧、またはデバイス情報セットのグローバルクラスドライバー一覧を構築します。

戻り値

この関数は、成功した場合に TRUE を返します。それ以外の場合は FALSE を返し、記録されたエラーは GetLastError を呼び出すことで取得できます。

解説(Remarks)

SetupDiBuildDriverInfoList はローカルコンピューター上のドライバーのみを検索するため、デバイス情報セットはローカルコンピューターのものである必要があります。デバイス情報セットがリモートコンピューターのものである場合、この関数は TRUE を返しますが、デバイス情報セットの既存のドライバー一覧、および指定されている場合はデバイス情報要素のドライバー一覧を実際には更新しません。

呼び出し元は、デバイス情報セットまたは特定のデバイス (DeviceInfoData) に関連付けられた SP_DEVINSTALL_PARAMS の Flags を設定して、一覧の構築方法を制御できます。たとえば、呼び出し元が DI_FLAGSEX_ALLOWEXCLUDEDDRVS フラグを設定すると、Exclude From Select としてマークされたドライバーも含められます。

ドライバーが "Exclude From Select" となるのは、INF ファイル内で ExcludeFromSelect としてマークされている場合、または、そのデバイスのセットアップクラス全体がクラスインストーラーの INF ファイル内で NoInstallClass もしくは NoUseClass としてマークされているデバイス用のドライバーである場合です。PnP デバイス用のドライバーは通常 "Exclude From Select" です。PnP デバイスは手動でインストールすべきではありません。PnP デバイス用のドライバーファイルの一覧を構築するには、SetupDiBuildDriverInfoList の呼び出し元はこのフラグを設定する必要があります。

SP_DEVINSTALL_PARAMS の DriverPath には、INF ファイルを含むディレクトリのパス、または特定の INF ファイルのパスのいずれかが格納されます。DI_ENUMSINGLEINF が設定されている場合、DriverPath には単一の INF ファイルのパスが格納されます。DriverPath が NULL の場合、この関数は既定の INF ファイルの場所である %SystemRoot%\inf からドライバー一覧を構築します。

この関数が指定されたドライバー一覧を構築した後、呼び出し元は SetupDiEnumDriverInfo を呼び出すことで一覧のエントリを列挙できます。

ドライバー一覧がデバイスインスタンスに関連付けられている場合 (つまり DeviceInfoData が指定されている場合)、生成される一覧は、関連付けられたデバイスインスタンスと同じクラスを持つドライバーで構成されます。グローバルクラスドライバー一覧の場合 (つまり DriverType が SPDIT_CLASSDRIVER で、DeviceInfoData が指定されていない場合)、一覧の構築時に使用されるクラスは、デバイス情報セットに関連付けられたクラスです。デバイス情報セットに関連付けられたクラスがない場合は、一覧の構築時にすべてのクラスのドライバーが使用されます。

別のスレッドから SetupDiCancelDriverInfoSearch を呼び出すことで、ドライバー一覧の構築を終了させることができます。

DeviceInfoSet には、ローカルコンピューター上の要素のみが含まれている必要があります。この関数はローカルのドライバーのみを検索します。

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

各言語での呼び出し定義

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

BOOL SetupDiBuildDriverInfoList(
    HDEVINFO DeviceInfoSet,
    SP_DEVINFO_DATA* DeviceInfoData,   // optional
    SETUP_DI_DRIVER_TYPE DriverType
);

[return: MarshalAs(UnmanagedType.Bool)]
[DllImport("SETUPAPI.dll", SetLastError = true, ExactSpelling = true)]
static extern bool SetupDiBuildDriverInfoList(
    IntPtr DeviceInfoSet,   // HDEVINFO
    IntPtr DeviceInfoData,   // SP_DEVINFO_DATA* optional, in/out
    uint DriverType   // SETUP_DI_DRIVER_TYPE
);

<DllImport("SETUPAPI.dll", SetLastError:=True, ExactSpelling:=True)>
Public Shared Function SetupDiBuildDriverInfoList(
    DeviceInfoSet As IntPtr,   ' HDEVINFO
    DeviceInfoData As IntPtr,   ' SP_DEVINFO_DATA* optional, in/out
    DriverType As UInteger   ' SETUP_DI_DRIVER_TYPE
) As <MarshalAs(UnmanagedType.Bool)> Boolean
End Function

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

import ctypes
from ctypes import wintypes

SetupDiBuildDriverInfoList = ctypes.windll.setupapi.SetupDiBuildDriverInfoList
SetupDiBuildDriverInfoList.restype = wintypes.BOOL
SetupDiBuildDriverInfoList.argtypes = [
    ctypes.c_ssize_t,  # DeviceInfoSet : HDEVINFO
    ctypes.c_void_p,  # DeviceInfoData : SP_DEVINFO_DATA* optional, in/out
    wintypes.DWORD,  # DriverType : SETUP_DI_DRIVER_TYPE
]
# GetLastError: use ctypes.GetLastError() (or ctypes.WinDLL(use_last_error=True))

require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('SETUPAPI.dll')
SetupDiBuildDriverInfoList = Fiddle::Function.new(
  lib['SetupDiBuildDriverInfoList'],
  [
    Fiddle::TYPE_INTPTR_T,  # DeviceInfoSet : HDEVINFO
    Fiddle::TYPE_VOIDP,  # DeviceInfoData : SP_DEVINFO_DATA* optional, in/out
    -Fiddle::TYPE_INT,  # DriverType : SETUP_DI_DRIVER_TYPE
  ],
  Fiddle::TYPE_INT)

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

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

出力引数:

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