ホーム › Devices.DeviceAndDriverInstallation › SetupDiCallClassInstaller

SetupDiCallClassInstaller

関数

デバイスのクラスインストーラに指定関数を呼び出させる。

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

シグネチャ

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

BOOL SetupDiCallClassInstaller(
    DI_FUNCTION InstallFunction,
    HDEVINFO DeviceInfoSet,
    SP_DEVINFO_DATA* DeviceInfoData   // optional
);

パラメーター

名前	型	方向	説明
InstallFunction	DI_FUNCTION	in	コインストーラーおよびクラスインストーラーに渡すデバイスインストール要求 (DIF 要求) です。DIF コードは DIF_XXX という形式で、Setupapi.h に定義されています。詳細については、Device Installation Function Codes を参照してください。メモ一部の DIF 要求では、呼び出し元が Administrators グループのメンバーである必要があります。そのような DIF 要求では、この要件が対応する既定のハンドラーのリファレンスページに記載されています。
DeviceInfoSet	HDEVINFO	in	ローカルコンピューターのデバイス情報セットへのハンドルです。このセットには、指定されたインストール関数を実行する対象のデバイスを表すデバイスインストール要素が含まれます。
DeviceInfoData	SP_DEVINFO_DATA*	inoptional	指定されたインストール関数を実行する対象のデバイスを表す、DeviceInfoSet 内のデバイス情報要素を指定する SP_DEVINFO_DATA 構造体へのポインターです。このパラメーターは省略可能で、NULL を設定できます。このパラメーターを指定した場合、SetupDiCallClassInstaller は DeviceInfoData 要素に対して指定された関数を実行します。DeviceInfoData が NULL の場合、SetupDiCallClassInstaller は DeviceInfoSet に関連付けられたセットアップクラスのインストーラーを呼び出します。

戻り値の型: BOOL

公式ドキュメント

SetupDiCallClassInstaller 関数は、指定されたインストール要求 (DIF コード) を使用して、適切なクラスインストーラーおよび登録済みのすべてのコインストーラーを呼び出します。

戻り値

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

GetLastError が ERROR_IN_WOW64 を返した場合、呼び出し元のアプリケーションが 64 ビット環境で実行しようとしている 32 ビットアプリケーションであることを意味します。これは許可されていません。

解説(Remarks)

SetupDiCallClassInstaller は、デバイスまたはデバイスセットアップクラスに対して登録されているクラスインストーラーおよびすべてのコインストーラーを呼び出します。この関数は、インストーラーがまだ読み込まれていない場合はそれらを読み込みます。また、DIF 要求に既定のハンドラーが存在し、かつインストーラーが既定のハンドラーを呼び出すべきであることを示すステータスを返した場合には、その既定のハンドラーも呼び出します。

デバイスインストールアプリケーションは、さまざまなデバイスインストール関数コード (DIF コード) を指定してこの関数を呼び出します。この関数は、指定された DIF 要求に対して、適切なすべてのインストーラーと既定のハンドラーが正しい順序で呼び出されることを保証します。詳細については、Handling DIF Codes を参照してください。

SetupDiCallClassInstaller が TRUE を返した後、デバイスインストールアプリケーションは SetupDiGetDeviceInstallParams を呼び出して SP_DEVINSTALL_PARAMS 構造体を取得する必要があります。この構造体の DI_NEEDREBOOT フラグまたは DI_NEEDRESTART フラグが設定されている場合、呼び出し元はシステムの再起動をユーザーに求める必要があります。たとえば、SetupPromptReboot を呼び出すことでこれを行えます。

ただし、デバイスインストールアプリケーションがシステムの再起動を要求するのは多くても 1 回にすべきであることに注意してください。したがって、SetupDiCallClassInstaller と SetupDiGetDeviceInstallParams を複数回呼び出すデバイスインストールアプリケーションでは、各呼び出しの後に DI_NEEDREBOOT フラグと DI_NEEDRESTART フラグを保存しておく必要があります。そして、最後の呼び出しが返った後にのみユーザーに確認を求めるようにします。

SetupDiCallClassInstaller が渡した DIF コードへの応答として、クラスインストーラーやコインストーラーがシステムの再起動を必要とする操作を実行する場合があります。そのような場合、インストーラーまたはコインストーラーは次の処理を行う必要があります。

SetupDiGetDeviceInstallParams を呼び出して SP_DEVINSTALL_PARAMS 構造体を取得します。
構造体の Flags メンバーに DI_NEEDREBOOT フラグまたは DI_NEEDRESTART フラグを設定します。
更新した SP_DEVINSTALL_PARAMS 構造体を指定して SetupDiSetDeviceInstallParams を呼び出し、変更した Flags メンバーを保存します。

SetupDiCallClassInstaller が返った後、それを呼び出したデバイスインストールアプリケーションは SetupDiGetDeviceInstallParams を呼び出してフラグを確認し、必要に応じて再起動を要求する必要があります。

DeviceInfoSet で指定されるデバイス情報セットには、ローカルコンピューター上のデバイスの要素のみを含める必要があります。

コインストーラーの設計と動作については、Writing a Co-installer を参照してください。

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

各言語での呼び出し定義

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

BOOL SetupDiCallClassInstaller(
    DI_FUNCTION InstallFunction,
    HDEVINFO DeviceInfoSet,
    SP_DEVINFO_DATA* DeviceInfoData   // optional
);

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

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

' InstallFunction : DI_FUNCTION
' DeviceInfoSet : HDEVINFO
' DeviceInfoData : SP_DEVINFO_DATA* optional
Declare PtrSafe Function SetupDiCallClassInstaller Lib "setupapi" ( _
    ByVal InstallFunction As Long, _
    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

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

require 'fiddle'
require 'fiddle/import'

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

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

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

出力引数:

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