ホーム › Devices.DeviceAndDriverInstallation › SetupDiGetINFClassW

SetupDiGetINFClassW

関数

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

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

シグネチャ

// SETUPAPI.dll  (Unicode / -W)
#include <windows.h>

BOOL SetupDiGetINFClassW(
    LPCWSTR InfName,
    GUID* ClassGuid,
    LPWSTR ClassName,
    DWORD ClassNameSize,
    DWORD* RequiredSize   // optional
);

パラメーター

名前	型	方向	説明
InfName	LPCWSTR	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	LPWSTR	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 ファイルのクラスを返します。(Unicode)

戻り値

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

解説(Remarks)

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

メモ

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

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

各言語での呼び出し定義

// SETUPAPI.dll  (Unicode / -W)
#include <windows.h>

BOOL SetupDiGetINFClassW(
    LPCWSTR InfName,
    GUID* ClassGuid,
    LPWSTR ClassName,
    DWORD ClassNameSize,
    DWORD* RequiredSize   // optional
);

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

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

' InfName : LPCWSTR
' ClassGuid : GUID* out
' ClassName : LPWSTR out
' ClassNameSize : DWORD
' RequiredSize : DWORD* optional, out
Declare PtrSafe Function SetupDiGetINFClassW Lib "setupapi" ( _
    ByVal InfName As LongPtr, _
    ByVal ClassGuid As LongPtr, _
    ByVal ClassName As LongPtr, _
    ByVal ClassNameSize As Long, _
    ByVal RequiredSize As LongPtr) As Long
' Unicode(W): 文字列は ByVal As LongPtr とし StrPtr(unicodeStr) を渡す
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。

import ctypes
from ctypes import wintypes

SetupDiGetINFClassW = ctypes.windll.setupapi.SetupDiGetINFClassW
SetupDiGetINFClassW.restype = wintypes.BOOL
SetupDiGetINFClassW.argtypes = [
    wintypes.LPCWSTR,  # InfName : LPCWSTR
    ctypes.c_void_p,  # ClassGuid : GUID* out
    wintypes.LPWSTR,  # ClassName : LPWSTR 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')
SetupDiGetINFClassW = Fiddle::Function.new(
  lib['SetupDiGetINFClassW'],
  [
    Fiddle::TYPE_VOIDP,  # InfName : LPCWSTR
    Fiddle::TYPE_VOIDP,  # ClassGuid : GUID* out
    Fiddle::TYPE_VOIDP,  # ClassName : LPWSTR out
    -Fiddle::TYPE_INT,  # ClassNameSize : DWORD
    Fiddle::TYPE_VOIDP,  # RequiredSize : DWORD* optional, out
  ],
  Fiddle::TYPE_INT)
# Wide strings: pass str.encode("UTF-16LE") + "\x00\x00"

#[link(name = "setupapi")]
extern "system" {
    fn SetupDiGetINFClassW(
        InfName: *const u16,  // LPCWSTR
        ClassGuid: *mut GUID,  // GUID* out
        ClassName: *mut u16,  // LPWSTR 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.Unicode, SetLastError = true)]
public static extern bool SetupDiGetINFClassW([MarshalAs(UnmanagedType.LPWStr)] string InfName, out Guid ClassGuid, [MarshalAs(UnmanagedType.LPWStr)] System.Text.StringBuilder ClassName, uint ClassNameSize, IntPtr RequiredSize);
"@
$api = Add-Type -MemberDefinition $sig -Name 'SETUPAPI_SetupDiGetINFClassW' -Namespace Win32 -PassThru
# $api::SetupDiGetINFClassW(InfName, ClassGuid, ClassName, ClassNameSize, RequiredSize)

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

出力引数:

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