ホーム › Devices.DeviceAndDriverInstallation › SetupDiGetClassInstallParamsA

SetupDiGetClassInstallParamsA

関数

デバイスまたはクラスのクラスインストールパラメータを取得する。

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

シグネチャ

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

BOOL SetupDiGetClassInstallParamsA(
    HDEVINFO DeviceInfoSet,
    SP_DEVINFO_DATA* DeviceInfoData,   // optional
    SP_CLASSINSTALL_HEADER* ClassInstallParams,   // optional
    DWORD ClassInstallParamsSize,
    DWORD* RequiredSize   // optional
);

パラメーター

名前	型	方向	説明
DeviceInfoSet	HDEVINFO	in	取得対象のクラスインストールパラメーターを含むデバイス情報セットへのハンドル。
DeviceInfoData	SP_DEVINFO_DATA*	inoptional	DeviceInfoSet 内のデバイス情報要素を指定する SP_DEVINFO_DATA 構造体へのポインター。このパラメーターは省略可能で、NULL を指定できます。このパラメーターを指定した場合、SetupDiGetClassInstallParams は指定されたデバイスのクラスインストールパラメーターを取得します。このパラメーターが NULL の場合、SetupDiGetClassInstallParams は DeviceInfoSet に関連付けられたグローバルクラスドライバーリストのクラスインストールパラメーターを取得します。
ClassInstallParams	SP_CLASSINSTALL_HEADER*	outoptional	SP_CLASSINSTALL_HEADER 構造体を含むバッファーへのポインター。この構造体は、入力時に cbSize メンバーに sizeof(SP_CLASSINSTALL_HEADER) を設定しておく必要があります。設定しない場合、バッファーは無効と見なされます。出力時には、取得されるクラスインストールパラメーターに対応するデバイスインストール関数コードが InstallFunction メンバーに格納されます。バッファーが十分な大きさであれば、その関数コードに固有のクラスインストールパラメーター構造体も受け取ります。ClassInstallParams を指定しない場合、ClassInstallParamsSize は 0 でなければなりません。
ClassInstallParamsSize	DWORD	in	ClassInstallParams バッファーのサイズ (バイト単位)。バッファーを指定する場合、そのサイズは少なくとも sizeof(SP_CLASSINSTALL_HEADER) 以上である必要があります。バッファーを指定しない場合、ClassInstallParamsSize は 0 でなければなりません。
RequiredSize	DWORD*	outoptional	クラスインストールパラメーターの格納に必要なバイト数を受け取る DWORD 型の変数へのポインター。このパラメーターは省略可能で、NULL を指定できます。

戻り値の型: BOOL

公式ドキュメント

SetupDiGetClassInstallParams 関数は、デバイス情報セットまたは特定のデバイス情報要素のクラスインストールパラメーターを取得します。(ANSI)

戻り値

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

解説(Remarks)

クラスインストールパラメーターは、ClassInstallParams バッファーの先頭にある ClassInstallHeader フィールドに格納された特定のデバイスインストール関数コードに固有のものです。

メモ

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

出典・ライセンス: 上記「公式ドキュメント」の内容は 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 SetupDiGetClassInstallParamsA(
    HDEVINFO DeviceInfoSet,
    SP_DEVINFO_DATA* DeviceInfoData,   // optional
    SP_CLASSINSTALL_HEADER* ClassInstallParams,   // optional
    DWORD ClassInstallParamsSize,
    DWORD* RequiredSize   // optional
);

[return: MarshalAs(UnmanagedType.Bool)]
[DllImport("SETUPAPI.dll", CharSet = CharSet.Ansi, SetLastError = true, ExactSpelling = true)]
static extern bool SetupDiGetClassInstallParamsA(
    IntPtr DeviceInfoSet,   // HDEVINFO
    IntPtr DeviceInfoData,   // SP_DEVINFO_DATA* optional
    IntPtr ClassInstallParams,   // SP_CLASSINSTALL_HEADER* optional, out
    uint ClassInstallParamsSize,   // DWORD
    IntPtr RequiredSize   // DWORD* optional, out
);

<DllImport("SETUPAPI.dll", CharSet:=CharSet.Ansi, SetLastError:=True, ExactSpelling:=True)>
Public Shared Function SetupDiGetClassInstallParamsA(
    DeviceInfoSet As IntPtr,   ' HDEVINFO
    DeviceInfoData As IntPtr,   ' SP_DEVINFO_DATA* optional
    ClassInstallParams As IntPtr,   ' SP_CLASSINSTALL_HEADER* optional, out
    ClassInstallParamsSize As UInteger,   ' DWORD
    RequiredSize As IntPtr   ' DWORD* optional, out
) As <MarshalAs(UnmanagedType.Bool)> Boolean
End Function

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

import ctypes
from ctypes import wintypes

SetupDiGetClassInstallParamsA = ctypes.windll.setupapi.SetupDiGetClassInstallParamsA
SetupDiGetClassInstallParamsA.restype = wintypes.BOOL
SetupDiGetClassInstallParamsA.argtypes = [
    ctypes.c_ssize_t,  # DeviceInfoSet : HDEVINFO
    ctypes.c_void_p,  # DeviceInfoData : SP_DEVINFO_DATA* optional
    ctypes.c_void_p,  # ClassInstallParams : SP_CLASSINSTALL_HEADER* optional, out
    wintypes.DWORD,  # ClassInstallParamsSize : DWORD
    ctypes.POINTER(wintypes.DWORD),  # RequiredSize : DWORD* optional, out
]
# GetLastError: use ctypes.GetLastError() (or ctypes.WinDLL(use_last_error=True))

require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('SETUPAPI.dll')
SetupDiGetClassInstallParamsA = Fiddle::Function.new(
  lib['SetupDiGetClassInstallParamsA'],
  [
    Fiddle::TYPE_INTPTR_T,  # DeviceInfoSet : HDEVINFO
    Fiddle::TYPE_VOIDP,  # DeviceInfoData : SP_DEVINFO_DATA* optional
    Fiddle::TYPE_VOIDP,  # ClassInstallParams : SP_CLASSINSTALL_HEADER* optional, out
    -Fiddle::TYPE_INT,  # ClassInstallParamsSize : DWORD
    Fiddle::TYPE_VOIDP,  # RequiredSize : DWORD* optional, out
  ],
  Fiddle::TYPE_INT)

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

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

出力引数:

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