ホーム › Devices.DeviceAndDriverInstallation › SetupDiGetINFClassA

SetupDiGetINFClassA

関数

INFファイルからセットアップクラスのGUIDと名前を取得する。

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

シグネチャ

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

BOOL SetupDiGetINFClassA(
    LPCSTR InfName,
    GUID* ClassGuid,
    LPSTR ClassName,
    DWORD ClassNameSize,
    DWORD* RequiredSize   // optional
);

パラメーター

名前	型	方向	説明
InfName	LPCSTR	in	デバイス INF ファイルの名前を指定する NULL 終端文字列へのポインター。この名前にはパスを含めることができます。ただし、ファイル名のみを指定した場合、そのファイルはレジストリの HKLM\SOFTWARE\Microsoft\Windows\CurrentVersion サブキー配下の DevicePath エントリに列挙された各ディレクトリ内で検索されます。NULL 終端の INF ファイル名の最大長は、NULL 終端文字を含めて MAX_PATH 文字です。
ClassGuid	GUID*	out	指定された INF ファイルのクラス GUID を受け取る、GUID 型の変数へのポインター。INF ファイルがクラス名を指定していない場合、この関数は GUID_NULL 構造体を返します。この名前を持つクラスが 1 つ以上既にインストールされているかどうかを判断するには、SetupDiClassGuidsFromName を呼び出してください。
ClassName	LPSTR	out	指定された INF ファイルのクラス名を格納する NULL 終端文字列を受け取るバッファーへのポインター。INF ファイルがクラス名を指定していないが GUID を指定している場合、このバッファーは SetupDiClassNameFromGuid の呼び出しによって取得される名前を受け取ります。ただし、SetupDiClassNameFromGuid がクラス名を取得できない場合(たとえば、そのクラスがインストールされていない場合)は、空の文字列を返します。
ClassNameSize	DWORD	in	ClassName パラメーターが指すバッファーのサイズ(文字数)。NULL 終端のクラス名の最大長は、文字数で MAX_CLASS_NAME_LEN です。
RequiredSize	DWORD*	outoptional	終端の NULL を含め、クラス名の格納に必要な文字数を受け取る DWORD 型の変数へのポインター。このポインターは省略可能で、NULL を指定できます。

戻り値の型: BOOL

公式ドキュメント

SetupDiGetINFClass 関数は、指定されたデバイス INF ファイルのクラスを返します。(ANSI)

戻り値

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

解説(Remarks)

この関数を Windows 9x または Millennium Edition 用の INF ファイルに対して使用しないでください。

メモ

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

出典・ライセンス: 上記「公式ドキュメント」の内容は 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 SetupDiGetINFClassA(
    LPCSTR InfName,
    GUID* ClassGuid,
    LPSTR ClassName,
    DWORD ClassNameSize,
    DWORD* RequiredSize   // optional
);

[return: MarshalAs(UnmanagedType.Bool)]
[DllImport("SETUPAPI.dll", CharSet = CharSet.Ansi, SetLastError = true, ExactSpelling = true)]
static extern bool SetupDiGetINFClassA(
    [MarshalAs(UnmanagedType.LPStr)] string InfName,   // LPCSTR
    out Guid ClassGuid,   // GUID* out
    [MarshalAs(UnmanagedType.LPStr)] System.Text.StringBuilder ClassName,   // LPSTR out
    uint ClassNameSize,   // DWORD
    IntPtr RequiredSize   // DWORD* optional, out
);

<DllImport("SETUPAPI.dll", CharSet:=CharSet.Ansi, SetLastError:=True, ExactSpelling:=True)>
Public Shared Function SetupDiGetINFClassA(
    <MarshalAs(UnmanagedType.LPStr)> InfName As String,   ' LPCSTR
    <Out> ByRef ClassGuid As Guid,   ' GUID* out
    <MarshalAs(UnmanagedType.LPStr)> ClassName As System.Text.StringBuilder,   ' LPSTR out
    ClassNameSize As UInteger,   ' DWORD
    RequiredSize As IntPtr   ' DWORD* optional, out
) As <MarshalAs(UnmanagedType.Bool)> Boolean
End Function

' InfName : LPCSTR
' ClassGuid : GUID* out
' ClassName : LPSTR out
' ClassNameSize : DWORD
' RequiredSize : DWORD* optional, out
Declare PtrSafe Function SetupDiGetINFClassA Lib "setupapi" ( _
    ByVal InfName As String, _
    ByVal ClassGuid As LongPtr, _
    ByVal ClassName As String, _
    ByVal ClassNameSize 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

SetupDiGetINFClassA = ctypes.windll.setupapi.SetupDiGetINFClassA
SetupDiGetINFClassA.restype = wintypes.BOOL
SetupDiGetINFClassA.argtypes = [
    wintypes.LPCSTR,  # InfName : LPCSTR
    ctypes.c_void_p,  # ClassGuid : GUID* out
    wintypes.LPSTR,  # ClassName : LPSTR out
    wintypes.DWORD,  # ClassNameSize : 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')
SetupDiGetINFClassA = Fiddle::Function.new(
  lib['SetupDiGetINFClassA'],
  [
    Fiddle::TYPE_VOIDP,  # InfName : LPCSTR
    Fiddle::TYPE_VOIDP,  # ClassGuid : GUID* out
    Fiddle::TYPE_VOIDP,  # ClassName : LPSTR out
    -Fiddle::TYPE_INT,  # ClassNameSize : DWORD
    Fiddle::TYPE_VOIDP,  # RequiredSize : DWORD* optional, out
  ],
  Fiddle::TYPE_INT)

#[link(name = "setupapi")]
extern "system" {
    fn SetupDiGetINFClassA(
        InfName: *const u8,  // LPCSTR
        ClassGuid: *mut GUID,  // GUID* out
        ClassName: *mut u8,  // LPSTR out
        ClassNameSize: 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 SetupDiGetINFClassA([MarshalAs(UnmanagedType.LPStr)] string InfName, out Guid ClassGuid, [MarshalAs(UnmanagedType.LPStr)] System.Text.StringBuilder ClassName, uint ClassNameSize, IntPtr RequiredSize);
"@
$api = Add-Type -MemberDefinition $sig -Name 'SETUPAPI_SetupDiGetINFClassA' -Namespace Win32 -PassThru
# $api::SetupDiGetINFClassA(InfName, ClassGuid, ClassName, ClassNameSize, RequiredSize)

#uselib "SETUPAPI.dll"
#func global SetupDiGetINFClassA "SetupDiGetINFClassA" sptr, sptr, sptr, sptr, sptr
; SetupDiGetINFClassA InfName, varptr(ClassGuid), varptr(ClassName), ClassNameSize, varptr(RequiredSize)   ; 戻り値は stat
; InfName : LPCSTR -> "sptr"
; ClassGuid : GUID* out -> "sptr"
; ClassName : LPSTR out -> "sptr"
; ClassNameSize : DWORD -> "sptr"
; RequiredSize : DWORD* optional, out -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。

出力引数:

#uselib "SETUPAPI.dll"
#cfunc global SetupDiGetINFClassA "SetupDiGetINFClassA" str, var, var, int, var
; res = SetupDiGetINFClassA(InfName, ClassGuid, ClassName, ClassNameSize, RequiredSize)
; InfName : LPCSTR -> "str"
; ClassGuid : GUID* out -> "var"
; ClassName : LPSTR out -> "var"
; ClassNameSize : DWORD -> "int"
; RequiredSize : DWORD* optional, out -> "var"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。#uselib "SETUPAPI.dll"
#cfunc global SetupDiGetINFClassA "SetupDiGetINFClassA" str, sptr, sptr, int, sptr
; res = SetupDiGetINFClassA(InfName, varptr(ClassGuid), varptr(ClassName), ClassNameSize, varptr(RequiredSize))
; InfName : LPCSTR -> "str"
; ClassGuid : GUID* out -> "sptr"
; ClassName : LPSTR out -> "sptr"
; ClassNameSize : DWORD -> "int"
; RequiredSize : DWORD* optional, out -> "sptr"
; ※出力/バッファ引数はポインタ方式(token=sptr / 呼び出しは varptr(変数))。