ホーム › Devices.DeviceAndDriverInstallation › SetupOpenInfFileA

SetupOpenInfFileA

関数

INFファイルを開いてハンドルを取得する(ANSI)。

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

シグネチャ

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

void* SetupOpenInfFileA(
    LPCSTR FileName,
    LPCSTR InfClass,   // optional
    INF_STYLE InfStyle,
    DWORD* ErrorLine   // optional
);

パラメーター

名前	型	方向	説明
FileName	LPCSTR	in	開く INF ファイルの名前 (およびオプションのパス) を格納した、null で終わる文字列へのポインター。ファイル名にパス区切り文字が含まれていない場合は、まず %windir%\inf ディレクトリが検索され、次に %windir%\system32 ディレクトリが検索されます。ファイル名にパス区切り文字が含まれている場合は、完全パスの指定と見なされ、それ以上の処理は行われません。
InfClass	LPCSTR	inoptional	対象とする INF ファイルのクラスを格納した、null で終わる文字列への省略可能なポインター。この文字列は Version セクションの Class 値と一致する必要があります (例: Class=Net)。Class 値のエントリが無く、Version セクションに ClassGUID のエントリがある場合は、その GUID に対応するクラス名が取得され、比較に使用されます。
InfStyle	INF_STYLE	in	開く、または検索する INF ファイルのスタイル。このパラメーターには、次のフラグの組み合わせを指定できます。 INF_STYLE_OLDNT レガシーの INF ファイル形式です。 INF_STYLE_WIN4 Windows の INF ファイル形式です。
ErrorLine	DWORD*	outoptional	INF ファイルの読み込み中にエラーが発生した行番号 (1 から始まる) を、この関数が返す変数への省略可能なポインター。この値は、一般に GetLastError が ERROR_NOT_ENOUGH_MEMORY を返さない場合にのみ信頼できます。メモリ不足の状態が発生した場合、ErrorLine は 0 になることがあります。

戻り値の型: void*

公式ドキュメント

SetupOpenInfFile 関数は、INF ファイルを開き、そのハンドルを返します。(ANSI)

戻り値

関数が成功した場合は、開いた INF ファイルのハンドルを返します。それ以外の場合、戻り値は INVALID_HANDLE_VALUE です。拡張エラー情報は GetLastError を呼び出すことで取得できます。

解説(Remarks)

INF ファイルの種類が InfClass と一致しないために読み込みが失敗した場合、関数は INVALID_HANDLE_VALUE を返し、 GetLastError の呼び出しは ERROR_CLASS_MISMATCH を返します。

複数の INF ファイルスタイルを指定した場合、実際に開かれた INF ファイルのスタイルは SetupGetInfInformation 関数を呼び出すことで判別できます。

同じクラス名を持つクラス GUID が複数存在する可能性があるため、特定のクラス (つまり特定のクラス GUID) の INF ファイルを対象とする呼び出し元は、 SetupQueryInfVersionInformation を呼び出して INF ファイルから ClassGUID の値を取得してください。

レガシーの INF ファイルの場合、InfClass 文字列は INF ファイルの Identification セクションにある OptionType 値で指定された種類と一致する必要があります (例: OptionType=NetAdapter)。

メモ

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

出典・ライセンス: 上記「公式ドキュメント」の内容は 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>

void* SetupOpenInfFileA(
    LPCSTR FileName,
    LPCSTR InfClass,   // optional
    INF_STYLE InfStyle,
    DWORD* ErrorLine   // optional
);

[DllImport("SETUPAPI.dll", CharSet = CharSet.Ansi, SetLastError = true, ExactSpelling = true)]
static extern IntPtr SetupOpenInfFileA(
    [MarshalAs(UnmanagedType.LPStr)] string FileName,   // LPCSTR
    [MarshalAs(UnmanagedType.LPStr)] string InfClass,   // LPCSTR optional
    uint InfStyle,   // INF_STYLE
    IntPtr ErrorLine   // DWORD* optional, out
);

<DllImport("SETUPAPI.dll", CharSet:=CharSet.Ansi, SetLastError:=True, ExactSpelling:=True)>
Public Shared Function SetupOpenInfFileA(
    <MarshalAs(UnmanagedType.LPStr)> FileName As String,   ' LPCSTR
    <MarshalAs(UnmanagedType.LPStr)> InfClass As String,   ' LPCSTR optional
    InfStyle As UInteger,   ' INF_STYLE
    ErrorLine As IntPtr   ' DWORD* optional, out
) As IntPtr
End Function

' FileName : LPCSTR
' InfClass : LPCSTR optional
' InfStyle : INF_STYLE
' ErrorLine : DWORD* optional, out
Declare PtrSafe Function SetupOpenInfFileA Lib "setupapi" ( _
    ByVal FileName As String, _
    ByVal InfClass As String, _
    ByVal InfStyle As Long, _
    ByVal ErrorLine As LongPtr) As LongPtr
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。

import ctypes
from ctypes import wintypes

SetupOpenInfFileA = ctypes.windll.setupapi.SetupOpenInfFileA
SetupOpenInfFileA.restype = ctypes.c_void_p
SetupOpenInfFileA.argtypes = [
    wintypes.LPCSTR,  # FileName : LPCSTR
    wintypes.LPCSTR,  # InfClass : LPCSTR optional
    wintypes.DWORD,  # InfStyle : INF_STYLE
    ctypes.POINTER(wintypes.DWORD),  # ErrorLine : DWORD* optional, out
]
# GetLastError: use ctypes.GetLastError() (or ctypes.WinDLL(use_last_error=True))

require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('SETUPAPI.dll')
SetupOpenInfFileA = Fiddle::Function.new(
  lib['SetupOpenInfFileA'],
  [
    Fiddle::TYPE_VOIDP,  # FileName : LPCSTR
    Fiddle::TYPE_VOIDP,  # InfClass : LPCSTR optional
    -Fiddle::TYPE_INT,  # InfStyle : INF_STYLE
    Fiddle::TYPE_VOIDP,  # ErrorLine : DWORD* optional, out
  ],
  Fiddle::TYPE_VOIDP)

#[link(name = "setupapi")]
extern "system" {
    fn SetupOpenInfFileA(
        FileName: *const u8,  // LPCSTR
        InfClass: *const u8,  // LPCSTR optional
        InfStyle: u32,  // INF_STYLE
        ErrorLine: *mut u32  // DWORD* optional, out
    ) -> *mut ();
}
// crates: windows-sys provides ready-made bindings for this API.

$sig = @"
[DllImport("SETUPAPI.dll", CharSet = CharSet.Ansi, SetLastError = true)]
public static extern IntPtr SetupOpenInfFileA([MarshalAs(UnmanagedType.LPStr)] string FileName, [MarshalAs(UnmanagedType.LPStr)] string InfClass, uint InfStyle, IntPtr ErrorLine);
"@
$api = Add-Type -MemberDefinition $sig -Name 'SETUPAPI_SetupOpenInfFileA' -Namespace Win32 -PassThru
# $api::SetupOpenInfFileA(FileName, InfClass, InfStyle, ErrorLine)

#uselib "SETUPAPI.dll"
#func global SetupOpenInfFileA "SetupOpenInfFileA" sptr, sptr, sptr, sptr
; SetupOpenInfFileA FileName, InfClass, InfStyle, varptr(ErrorLine)   ; 戻り値は stat
; FileName : LPCSTR -> "sptr"
; InfClass : LPCSTR optional -> "sptr"
; InfStyle : INF_STYLE -> "sptr"
; ErrorLine : DWORD* optional, out -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。

出力引数:

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