ホーム › Devices.DeviceAndDriverInstallation › SetupOpenAppendInfFileA

SetupOpenAppendInfFileA

関数

既存のINFハンドルに別のINFファイルを追加で開く(ANSI)。

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

シグネチャ

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

BOOL SetupOpenAppendInfFileA(
    LPCSTR FileName,   // optional
    void* InfHandle,
    DWORD* ErrorLine   // optional
);

パラメーター

名前	型	方向	説明
FileName	LPCSTR	inoptional	NULL でない場合、FileName は、開く INF ファイルの名前 (および省略可能なパス) を格納した null 終端文字列を指します。ファイル名にパス区切り文字が含まれていない場合は、最初に %windir%\inf ディレクトリ、次に %windir%\system32 ディレクトリの順に検索されます。ファイル名にパス区切り文字が含まれている場合は、完全なパス指定と見なされ、それ以上の処理は行われません。FileName が NULL の場合、INF ファイル名は既存の INF ファイル内の Version セクションの LayoutFile 値から取得されます。LayoutFile キーから取得したファイル名にも同じ検索ロジックが適用されます。
InfHandle	void*	in	この INF ファイルの追加先となる、既存の INF ハンドル。
ErrorLine	DWORD*	outoptional	省略可能。INF ファイルの読み込み中にエラーが発生した行番号 (1 から始まる) を、この関数が返す変数へのポインター。この値が信頼できるのは、一般に GetLastError が ERROR_NOT_ENOUGH_MEMORY を返さない場合のみです。メモリ不足の状態が発生した場合、ErrorLine は 0 になることがあります。

戻り値の型: BOOL

公式ドキュメント

SetupOpenAppendInfFile 関数は、INF ファイル内の情報を、SetupOpenInfFile によって事前に開かれた INF ファイルに追加します。(ANSI)

戻り値

関数が成功すると、0 以外の値が返ります。

関数が失敗すると、0 が返ります。拡張エラー情報を取得するには、 GetLastError を呼び出します。

FileName が指定されず、かつ既存の INF ファイルの Version セクションに LayoutFile 値が存在しなかった場合、 GetLastError は ERROR_INVALID_DATA を返します。

解説(Remarks)

この関数には Windows の INF ファイルが必要です。古い形式の INF ファイルはサポートされない場合があります。その場合、関数は FALSE を返し、 GetLastError は ERROR_INVALID_PARAMETER を返します。この関数の主な目的は、INF ファイルと、Version セクションの LayoutFile エントリで指定されたファイル (通常は LAYOUT.INF) に含まれるソースファイルの場所情報とを結合することです。

INF ファイルが古い形式を使用している場合、SetupOpenAppendInfFile は ERROR_WRONG_INF_STYLE を返すこともあります。

メモ

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

出典・ライセンス: 上記「公式ドキュメント」の内容は 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 SetupOpenAppendInfFileA(
    LPCSTR FileName,   // optional
    void* InfHandle,
    DWORD* ErrorLine   // optional
);

[return: MarshalAs(UnmanagedType.Bool)]
[DllImport("SETUPAPI.dll", CharSet = CharSet.Ansi, SetLastError = true, ExactSpelling = true)]
static extern bool SetupOpenAppendInfFileA(
    [MarshalAs(UnmanagedType.LPStr)] string FileName,   // LPCSTR optional
    IntPtr InfHandle,   // void*
    IntPtr ErrorLine   // DWORD* optional, out
);

<DllImport("SETUPAPI.dll", CharSet:=CharSet.Ansi, SetLastError:=True, ExactSpelling:=True)>
Public Shared Function SetupOpenAppendInfFileA(
    <MarshalAs(UnmanagedType.LPStr)> FileName As String,   ' LPCSTR optional
    InfHandle As IntPtr,   ' void*
    ErrorLine As IntPtr   ' DWORD* optional, out
) As <MarshalAs(UnmanagedType.Bool)> Boolean
End Function

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

import ctypes
from ctypes import wintypes

SetupOpenAppendInfFileA = ctypes.windll.setupapi.SetupOpenAppendInfFileA
SetupOpenAppendInfFileA.restype = wintypes.BOOL
SetupOpenAppendInfFileA.argtypes = [
    wintypes.LPCSTR,  # FileName : LPCSTR optional
    ctypes.POINTER(None),  # InfHandle : void*
    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')
SetupOpenAppendInfFileA = Fiddle::Function.new(
  lib['SetupOpenAppendInfFileA'],
  [
    Fiddle::TYPE_VOIDP,  # FileName : LPCSTR optional
    Fiddle::TYPE_VOIDP,  # InfHandle : void*
    Fiddle::TYPE_VOIDP,  # ErrorLine : DWORD* optional, out
  ],
  Fiddle::TYPE_INT)

#[link(name = "setupapi")]
extern "system" {
    fn SetupOpenAppendInfFileA(
        FileName: *const u8,  // LPCSTR optional
        InfHandle: *mut (),  // void*
        ErrorLine: *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 SetupOpenAppendInfFileA([MarshalAs(UnmanagedType.LPStr)] string FileName, IntPtr InfHandle, IntPtr ErrorLine);
"@
$api = Add-Type -MemberDefinition $sig -Name 'SETUPAPI_SetupOpenAppendInfFileA' -Namespace Win32 -PassThru
# $api::SetupOpenAppendInfFileA(FileName, InfHandle, ErrorLine)

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

出力引数:

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