ホーム › Devices.DeviceAndDriverInstallation › SetupInstallFileA

SetupInstallFileA

関数

INF情報に基づき単一ファイルをコピーしてインストールする(ANSI)。

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

シグネチャ

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

BOOL SetupInstallFileA(
    void* InfHandle,   // optional
    INFCONTEXT* InfContext,   // optional
    LPCSTR SourceFile,   // optional
    LPCSTR SourcePathRoot,   // optional
    LPCSTR DestinationName,   // optional
    SP_COPY_STYLE CopyStyle,
    PSP_FILE_CALLBACK_A CopyMsgHandler,   // optional
    void* Context   // optional
);

パラメーター

名前

型

方向

説明

InfHandle

void*

inoptional

SourceDisksNames セクションと SourceDisksFiles セクションを含む INF ファイルのハンドルへのポインター (省略可能)。ユーザーのシステム用のプラットフォーム固有のセクション (たとえば SourceDisksNames.x86 や SourceDisksFiles.x86) が存在する場合は、そのプラットフォーム固有のセクションが使用されます。InfContext が null で、CopyStyle に SP_COPY_SOURCE_ABSOLUTE または SP_COPY_SOURCEPATH_ABSOLUTE が含まれる場合、InfHandle は無視されます。

InfContext

INFCONTEXT*

inoptional

INF ファイルの Copy Files セクション内にある行のコンテキストへのポインター (省略可能)。このルーチンは、InfHandle の SourceDisksFiles セクションでこのファイルを検索し、ファイルのコピー情報を取得します。InfHandle を指定しない場合は、SourceFile を指定する必要があります。

SourceFile

LPCSTR

inoptional

コピーするファイルのファイル名 (パスなし) へのポインター (省略可能)。このファイルは SourceDisksFiles セクションで検索されます。InfContext を指定しない場合は、SourceFile パラメーターを指定する必要があります。InfContext を指定した場合、SourceFile は無視されます。

SourcePathRoot

LPCSTR

inoptional

コピーするファイルのルートパス (たとえば A:\ や F:) へのポインター (省略可能)。SourceDisksNames セクション内のパスは、このパスに連結されます。CopyStyle に SP_COPY_SOURCE_ABSOLUTE フラグが含まれる場合、SourcePathRoot パラメーターは無視されます。

DestinationName

LPCSTR

inoptional

ターゲットファイルのファイル名のみ (パスなし) へのポインター (省略可能)。このパラメーターに null を指定すると、ターゲットファイルの名前をソースファイルと同じにすることを示します。InfContext を指定しない場合、DestinationName はターゲットの完全なパスとファイル名を指定します。

CopyStyle

SP_COPY_STYLE

ファイルのコピー操作の動作を制御するフラグ。これらのフラグには、次の値の組み合わせを指定できます。

値	意味
SP_COPY_DELETESOURCE	コピーが成功したら、ソースファイルを削除します。削除操作が失敗しても、呼び出し元には通知されません。
SP_COPY_REPLACEONLY	コピー先のパスにあるファイルを上書きすることになる場合にのみ、ファイルをコピーします。ターゲットが存在しない場合、この関数は FALSE を返し、 GetLastError は NO_ERROR を返します。
SP_COPY_NEWER_OR_SAME	コピーされる各ファイルについて、そのバージョンリソースが、ターゲット上の既存のコピーと同じバージョンであるか、またはそれより新しくないことを示しているかどうかを調べます。バージョンチェックで使用されるファイルのバージョン情報は、バージョン関数によって設定される VS_FIXEDFILEINFO 構造体の dwFileVersionMS メンバーと dwFileVersionLS メンバーに指定されている情報です。いずれかのファイルにバージョンリソースがない場合、または両者のバージョン情報が同一の場合、ソースファイルの方が新しいとみなされます。ソースファイルが新しくなく、バージョンも等しくない場合、CopyMsgHandler が指定されていれば呼び出し元に通知され、コピー操作をキャンセルできます。CopyMsgHandler が指定されていない場合、ファイルはコピーされません。
SP_COPY_NEWER_ONLY	コピーされる各ファイルについて、そのバージョンリソースが、ターゲット上の既存のコピーより新しくないことを示しているかどうかを調べます。ソースファイルの方が新しく、既存のターゲットとバージョンが等しくない場合、そのファイルはコピーされます。
SP_COPY_NOOVERWRITE	ターゲットファイルが存在するかどうかを確認し、存在する場合は呼び出し元に通知します。呼び出し元はコピーを拒否できます。CopyMsgHandler が指定されていない場合、ファイルは上書きされません。
SP_COPY_NODECOMP	ファイルを展開しません。このフラグを設定すると、ターゲットファイルには (必要に応じて) 非圧縮形式のソース名が付けられません。たとえば、F:\x86\cmd.ex_ を \\install\temp にコピーすると、ターゲットファイルは \\install\temp\cmd.ex_ になります。SP_COPY_NODECOMP フラグを指定しなかった場合、ファイルは展開され、ターゲットの名前は \\install\temp\cmd.exe になります。DestinationName が指定されている場合、そのファイル名部分は取り除かれ、ソースファイルのファイル名に置き換えられます。SP_COPY_NODECOMP を指定した場合、言語情報やバージョン情報はチェックできません。
SP_COPY_LANGUAGEAWARE	コピーされる各ファイルについて、その言語がターゲット上に既に存在するファイルの言語と異なるかどうかを調べます。異なっていて、かつ CopyMsgHandler が指定されている場合、呼び出し元に通知され、コピーをキャンセルできます。CopyMsgHandler が指定されていない場合、ファイルはコピーされません。
SP_COPY_SOURCE_ABSOLUTE	SourceFile は完全なソースパスです。INF ファイルの SourceDisksNames セクションで検索しません。
SP_COPY_SOURCEPATH_ABSOLUTE	SourcePathRoot はソースファイルの完全なパス部分です。ファイルが格納されているソースメディアについて、INF ファイルの SourceDisksNames セクションで指定された相対的なソース指定は無視されます。SP_COPY_SOURCE_ABSOLUTE が指定されている場合、このフラグは無視されます。
SP_COPY_FORCE_IN_USE	ターゲットが存在する場合、それが使用中であるかのように動作し、次回のシステム再起動時にコピーするようファイルをキューに登録します。
SP_COPY_FORCE_NOOVERWRITE	ターゲットファイルが存在するかどうかを確認し、存在する場合はファイルを上書きしません。呼び出し元には通知されません。
SP_COPY_FORCE_NEWER	コピーされる各ファイルについて、そのバージョンリソース (イメージファイル以外の場合はタイムスタンプ) が、ターゲット上の既存のコピーより新しくないことを示しているかどうかを調べます。コピーしようとするファイルの方が新しくない場合、そのファイルはコピーされません。呼び出し元には通知されません。この関数は FALSE を返し、 GetLastError は NO_ERROR を返します。

CopyMsgHandler

PSP_FILE_CALLBACK_A

inoptional

ファイルのコピー操作中に発生する可能性のあるさまざまな状況の通知を受け取るコールバック関数へのポインター (省略可能)。

Context

void*

inoptional

コールバック関数の最初のパラメーターとして渡される、呼び出し元定義の値へのポインター (省略可能)。

戻り値の型: BOOL

公式ドキュメント

SetupInstallFile 関数は、SetupFindXXXLine が返す INFCONTEXT で指定されたファイル、またはファイル名とパスで明示的に指定されたファイルをインストールします。(ANSI)

戻り値

関数が成功した場合、戻り値は 0 以外の値です。

関数が失敗した場合、戻り値は 0 です。拡張エラー情報を取得するには、 GetLastError を呼び出します。

GetLastError が NO_ERROR を返す場合、ファイルのコピー操作は完了していません。ファイルのコピー操作が不要であったか、ファイルのコールバック関数が FALSE を返したために、ファイルがコピーされなかった可能性があります。

解説(Remarks)

ファイルのインストール先ディレクトリとして UNC ディレクトリを指定する場合は、 SetupInstallFile を呼び出す前に、そのディレクトリが存在することを確認する必要があります。セットアップ関数は、UNC ディレクトリの存在確認も作成も行いません。インストール先の UNC ディレクトリが存在しない場合、ファイルのインストールは失敗します。

メモ

setupapi.h ヘッダーは、UNICODE プリプロセッサ定数の定義に基づいて、この関数の ANSI 版または Unicode 版を自動的に選択するエイリアスとして SetupInstallFile を定義しています。エンコーディング中立のエイリアスを、エンコーディング中立でないコードと混在させて使用すると、不一致が生じ、コンパイルエラーや実行時エラーの原因となることがあります。詳細については、「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 SetupInstallFileA(
    void* InfHandle,   // optional
    INFCONTEXT* InfContext,   // optional
    LPCSTR SourceFile,   // optional
    LPCSTR SourcePathRoot,   // optional
    LPCSTR DestinationName,   // optional
    SP_COPY_STYLE CopyStyle,
    PSP_FILE_CALLBACK_A CopyMsgHandler,   // optional
    void* Context   // optional
);

[return: MarshalAs(UnmanagedType.Bool)]
[DllImport("SETUPAPI.dll", CharSet = CharSet.Ansi, SetLastError = true, ExactSpelling = true)]
static extern bool SetupInstallFileA(
    IntPtr InfHandle,   // void* optional
    IntPtr InfContext,   // INFCONTEXT* optional
    [MarshalAs(UnmanagedType.LPStr)] string SourceFile,   // LPCSTR optional
    [MarshalAs(UnmanagedType.LPStr)] string SourcePathRoot,   // LPCSTR optional
    [MarshalAs(UnmanagedType.LPStr)] string DestinationName,   // LPCSTR optional
    uint CopyStyle,   // SP_COPY_STYLE
    IntPtr CopyMsgHandler,   // PSP_FILE_CALLBACK_A optional
    IntPtr Context   // void* optional
);

<DllImport("SETUPAPI.dll", CharSet:=CharSet.Ansi, SetLastError:=True, ExactSpelling:=True)>
Public Shared Function SetupInstallFileA(
    InfHandle As IntPtr,   ' void* optional
    InfContext As IntPtr,   ' INFCONTEXT* optional
    <MarshalAs(UnmanagedType.LPStr)> SourceFile As String,   ' LPCSTR optional
    <MarshalAs(UnmanagedType.LPStr)> SourcePathRoot As String,   ' LPCSTR optional
    <MarshalAs(UnmanagedType.LPStr)> DestinationName As String,   ' LPCSTR optional
    CopyStyle As UInteger,   ' SP_COPY_STYLE
    CopyMsgHandler As IntPtr,   ' PSP_FILE_CALLBACK_A optional
    Context As IntPtr   ' void* optional
) As <MarshalAs(UnmanagedType.Bool)> Boolean
End Function

' InfHandle : void* optional
' InfContext : INFCONTEXT* optional
' SourceFile : LPCSTR optional
' SourcePathRoot : LPCSTR optional
' DestinationName : LPCSTR optional
' CopyStyle : SP_COPY_STYLE
' CopyMsgHandler : PSP_FILE_CALLBACK_A optional
' Context : void* optional
Declare PtrSafe Function SetupInstallFileA Lib "setupapi" ( _
    ByVal InfHandle As LongPtr, _
    ByVal InfContext As LongPtr, _
    ByVal SourceFile As String, _
    ByVal SourcePathRoot As String, _
    ByVal DestinationName As String, _
    ByVal CopyStyle As Long, _
    ByVal CopyMsgHandler As LongPtr, _
    ByVal Context As LongPtr) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。

import ctypes
from ctypes import wintypes

SetupInstallFileA = ctypes.windll.setupapi.SetupInstallFileA
SetupInstallFileA.restype = wintypes.BOOL
SetupInstallFileA.argtypes = [
    ctypes.POINTER(None),  # InfHandle : void* optional
    ctypes.c_void_p,  # InfContext : INFCONTEXT* optional
    wintypes.LPCSTR,  # SourceFile : LPCSTR optional
    wintypes.LPCSTR,  # SourcePathRoot : LPCSTR optional
    wintypes.LPCSTR,  # DestinationName : LPCSTR optional
    wintypes.DWORD,  # CopyStyle : SP_COPY_STYLE
    ctypes.c_void_p,  # CopyMsgHandler : PSP_FILE_CALLBACK_A optional
    ctypes.POINTER(None),  # Context : void* optional
]
# GetLastError: use ctypes.GetLastError() (or ctypes.WinDLL(use_last_error=True))

require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('SETUPAPI.dll')
SetupInstallFileA = Fiddle::Function.new(
  lib['SetupInstallFileA'],
  [
    Fiddle::TYPE_VOIDP,  # InfHandle : void* optional
    Fiddle::TYPE_VOIDP,  # InfContext : INFCONTEXT* optional
    Fiddle::TYPE_VOIDP,  # SourceFile : LPCSTR optional
    Fiddle::TYPE_VOIDP,  # SourcePathRoot : LPCSTR optional
    Fiddle::TYPE_VOIDP,  # DestinationName : LPCSTR optional
    -Fiddle::TYPE_INT,  # CopyStyle : SP_COPY_STYLE
    Fiddle::TYPE_VOIDP,  # CopyMsgHandler : PSP_FILE_CALLBACK_A optional
    Fiddle::TYPE_VOIDP,  # Context : void* optional
  ],
  Fiddle::TYPE_INT)

#[link(name = "setupapi")]
extern "system" {
    fn SetupInstallFileA(
        InfHandle: *mut (),  // void* optional
        InfContext: *mut INFCONTEXT,  // INFCONTEXT* optional
        SourceFile: *const u8,  // LPCSTR optional
        SourcePathRoot: *const u8,  // LPCSTR optional
        DestinationName: *const u8,  // LPCSTR optional
        CopyStyle: u32,  // SP_COPY_STYLE
        CopyMsgHandler: *const core::ffi::c_void,  // PSP_FILE_CALLBACK_A optional
        Context: *mut ()  // void* optional
    ) -> 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 SetupInstallFileA(IntPtr InfHandle, IntPtr InfContext, [MarshalAs(UnmanagedType.LPStr)] string SourceFile, [MarshalAs(UnmanagedType.LPStr)] string SourcePathRoot, [MarshalAs(UnmanagedType.LPStr)] string DestinationName, uint CopyStyle, IntPtr CopyMsgHandler, IntPtr Context);
"@
$api = Add-Type -MemberDefinition $sig -Name 'SETUPAPI_SetupInstallFileA' -Namespace Win32 -PassThru
# $api::SetupInstallFileA(InfHandle, InfContext, SourceFile, SourcePathRoot, DestinationName, CopyStyle, CopyMsgHandler, Context)

#uselib "SETUPAPI.dll"
#func global SetupInstallFileA "SetupInstallFileA" sptr, sptr, sptr, sptr, sptr, sptr, sptr, sptr
; SetupInstallFileA InfHandle, varptr(InfContext), SourceFile, SourcePathRoot, DestinationName, CopyStyle, CopyMsgHandler, Context   ; 戻り値は stat
; InfHandle : void* optional -> "sptr"
; InfContext : INFCONTEXT* optional -> "sptr"
; SourceFile : LPCSTR optional -> "sptr"
; SourcePathRoot : LPCSTR optional -> "sptr"
; DestinationName : LPCSTR optional -> "sptr"
; CopyStyle : SP_COPY_STYLE -> "sptr"
; CopyMsgHandler : PSP_FILE_CALLBACK_A optional -> "sptr"
; Context : void* optional -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。

出力引数:

#uselib "SETUPAPI.dll"
#cfunc global SetupInstallFileA "SetupInstallFileA" sptr, var, str, str, str, int, sptr, sptr
; res = SetupInstallFileA(InfHandle, InfContext, SourceFile, SourcePathRoot, DestinationName, CopyStyle, CopyMsgHandler, Context)
; InfHandle : void* optional -> "sptr"
; InfContext : INFCONTEXT* optional -> "var"
; SourceFile : LPCSTR optional -> "str"
; SourcePathRoot : LPCSTR optional -> "str"
; DestinationName : LPCSTR optional -> "str"
; CopyStyle : SP_COPY_STYLE -> "int"
; CopyMsgHandler : PSP_FILE_CALLBACK_A optional -> "sptr"
; Context : void* optional -> "sptr"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。#uselib "SETUPAPI.dll"
#cfunc global SetupInstallFileA "SetupInstallFileA" sptr, sptr, str, str, str, int, sptr, sptr
; res = SetupInstallFileA(InfHandle, varptr(InfContext), SourceFile, SourcePathRoot, DestinationName, CopyStyle, CopyMsgHandler, Context)
; InfHandle : void* optional -> "sptr"
; InfContext : INFCONTEXT* optional -> "sptr"
; SourceFile : LPCSTR optional -> "str"
; SourcePathRoot : LPCSTR optional -> "str"
; DestinationName : LPCSTR optional -> "str"
; CopyStyle : SP_COPY_STYLE -> "int"
; CopyMsgHandler : PSP_FILE_CALLBACK_A optional -> "sptr"
; Context : void* optional -> "sptr"
; ※出力/バッファ引数はポインタ方式(token=sptr / 呼び出しは varptr(変数))。

出力引数:

; BOOL SetupInstallFileA(void* InfHandle, INFCONTEXT* InfContext, LPCSTR SourceFile, LPCSTR SourcePathRoot, LPCSTR DestinationName, SP_COPY_STYLE CopyStyle, PSP_FILE_CALLBACK_A CopyMsgHandler, void* Context)
#uselib "SETUPAPI.dll"
#cfunc global SetupInstallFileA "SetupInstallFileA" intptr, var, str, str, str, int, intptr, intptr
; res = SetupInstallFileA(InfHandle, InfContext, SourceFile, SourcePathRoot, DestinationName, CopyStyle, CopyMsgHandler, Context)
; InfHandle : void* optional -> "intptr"
; InfContext : INFCONTEXT* optional -> "var"
; SourceFile : LPCSTR optional -> "str"
; SourcePathRoot : LPCSTR optional -> "str"
; DestinationName : LPCSTR optional -> "str"
; CopyStyle : SP_COPY_STYLE -> "int"
; CopyMsgHandler : PSP_FILE_CALLBACK_A optional -> "intptr"
; Context : void* optional -> "intptr"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。; BOOL SetupInstallFileA(void* InfHandle, INFCONTEXT* InfContext, LPCSTR SourceFile, LPCSTR SourcePathRoot, LPCSTR DestinationName, SP_COPY_STYLE CopyStyle, PSP_FILE_CALLBACK_A CopyMsgHandler, void* Context)
#uselib "SETUPAPI.dll"
#cfunc global SetupInstallFileA "SetupInstallFileA" intptr, intptr, str, str, str, int, intptr, intptr
; res = SetupInstallFileA(InfHandle, varptr(InfContext), SourceFile, SourcePathRoot, DestinationName, CopyStyle, CopyMsgHandler, Context)
; InfHandle : void* optional -> "intptr"
; InfContext : INFCONTEXT* optional -> "intptr"
; SourceFile : LPCSTR optional -> "str"
; SourcePathRoot : LPCSTR optional -> "str"
; DestinationName : LPCSTR optional -> "str"
; CopyStyle : SP_COPY_STYLE -> "int"
; CopyMsgHandler : PSP_FILE_CALLBACK_A optional -> "intptr"
; Context : void* optional -> "intptr"
; ※出力/バッファ引数はポインタ方式(token=intptr / 呼び出しは varptr(変数))。

import (
	"golang.org/x/sys/windows"
	"unsafe"
)

var (
	setupapi = windows.NewLazySystemDLL("SETUPAPI.dll")
	procSetupInstallFileA = setupapi.NewProc("SetupInstallFileA")
)

// InfHandle (void* optional), InfContext (INFCONTEXT* optional), SourceFile (LPCSTR optional), SourcePathRoot (LPCSTR optional), DestinationName (LPCSTR optional), CopyStyle (SP_COPY_STYLE), CopyMsgHandler (PSP_FILE_CALLBACK_A optional), Context (void* optional)
r1, _, err := procSetupInstallFileA.Call(
	uintptr(InfHandle),
	uintptr(InfContext),
	uintptr(unsafe.Pointer(windows.BytePtrFromString(SourceFile))),
	uintptr(unsafe.Pointer(windows.BytePtrFromString(SourcePathRoot))),
	uintptr(unsafe.Pointer(windows.BytePtrFromString(DestinationName))),
	uintptr(CopyStyle),
	uintptr(CopyMsgHandler),
	uintptr(Context),
)
_ = err  // syscall.Errno (valid when the call sets last-error)
_ = r1   // BOOL

function SetupInstallFileA(
  InfHandle: Pointer;   // void* optional
  InfContext: Pointer;   // INFCONTEXT* optional
  SourceFile: PAnsiChar;   // LPCSTR optional
  SourcePathRoot: PAnsiChar;   // LPCSTR optional
  DestinationName: PAnsiChar;   // LPCSTR optional
  CopyStyle: DWORD;   // SP_COPY_STYLE
  CopyMsgHandler: Pointer;   // PSP_FILE_CALLBACK_A optional
  Context: Pointer   // void* optional
): BOOL; stdcall;
  external 'SETUPAPI.dll' name 'SetupInstallFileA';

result := DllCall("SETUPAPI\SetupInstallFileA"
    , "Ptr", InfHandle   ; void* optional
    , "Ptr", InfContext   ; INFCONTEXT* optional
    , "AStr", SourceFile   ; LPCSTR optional
    , "AStr", SourcePathRoot   ; LPCSTR optional
    , "AStr", DestinationName   ; LPCSTR optional
    , "UInt", CopyStyle   ; SP_COPY_STYLE
    , "Ptr", CopyMsgHandler   ; PSP_FILE_CALLBACK_A optional
    , "Ptr", Context   ; void* optional
    , "Int")   ; return: BOOL

●SetupInstallFileA(InfHandle, InfContext, SourceFile, SourcePathRoot, DestinationName, CopyStyle, CopyMsgHandler, Context) = DLL("SETUPAPI.dll", "bool SetupInstallFileA(void*, void*, char*, char*, char*, dword, void*, void*)")
# 呼び出し: SetupInstallFileA(InfHandle, InfContext, SourceFile, SourcePathRoot, DestinationName, CopyStyle, CopyMsgHandler, Context)
# InfHandle : void* optional -> "void*"
# InfContext : INFCONTEXT* optional -> "void*"
# SourceFile : LPCSTR optional -> "char*"
# SourcePathRoot : LPCSTR optional -> "char*"
# DestinationName : LPCSTR optional -> "char*"
# CopyStyle : SP_COPY_STYLE -> "dword"
# CopyMsgHandler : PSP_FILE_CALLBACK_A optional -> "void*"
# Context : void* optional -> "void*"
# なでしこ1は32bit・ANSI(Shift_JIS)。文字列=char*(ANSI)、ポインタ/ハンドル=void*(4byte)。

const std = @import("std");

extern "setupapi" fn SetupInstallFileA(
    InfHandle: ?*anyopaque, // void* optional
    InfContext: [*c]INFCONTEXT, // INFCONTEXT* optional
    SourceFile: [*c]const u8, // LPCSTR optional
    SourcePathRoot: [*c]const u8, // LPCSTR optional
    DestinationName: [*c]const u8, // LPCSTR optional
    CopyStyle: u32, // SP_COPY_STYLE
    CopyMsgHandler: ?*anyopaque, // PSP_FILE_CALLBACK_A optional
    Context: ?*anyopaque // void* optional
) callconv(std.os.windows.WINAPI) i32;

proc SetupInstallFileA(
    InfHandle: pointer,  # void* optional
    InfContext: ptr INFCONTEXT,  # INFCONTEXT* optional
    SourceFile: cstring,  # LPCSTR optional
    SourcePathRoot: cstring,  # LPCSTR optional
    DestinationName: cstring,  # LPCSTR optional
    CopyStyle: uint32,  # SP_COPY_STYLE
    CopyMsgHandler: pointer,  # PSP_FILE_CALLBACK_A optional
    Context: pointer  # void* optional
): int32 {.importc: "SetupInstallFileA", stdcall, dynlib: "SETUPAPI.dll".}

pragma(lib, "setupapi");
extern(Windows)
int SetupInstallFileA(
    void* InfHandle,   // void* optional
    INFCONTEXT* InfContext,   // INFCONTEXT* optional
    const(char)* SourceFile,   // LPCSTR optional
    const(char)* SourcePathRoot,   // LPCSTR optional
    const(char)* DestinationName,   // LPCSTR optional
    uint CopyStyle,   // SP_COPY_STYLE
    void* CopyMsgHandler,   // PSP_FILE_CALLBACK_A optional
    void* Context   // void* optional
);

ccall((:SetupInstallFileA, "SETUPAPI.dll"), stdcall, Int32,
      (Ptr{Cvoid}, Ptr{INFCONTEXT}, Cstring, Cstring, Cstring, UInt32, Ptr{Cvoid}, Ptr{Cvoid}),
      InfHandle, InfContext, SourceFile, SourcePathRoot, DestinationName, CopyStyle, CopyMsgHandler, Context)
# InfHandle : void* optional -> Ptr{Cvoid}
# InfContext : INFCONTEXT* optional -> Ptr{INFCONTEXT}
# SourceFile : LPCSTR optional -> Cstring
# SourcePathRoot : LPCSTR optional -> Cstring
# DestinationName : LPCSTR optional -> Cstring
# CopyStyle : SP_COPY_STYLE -> UInt32
# CopyMsgHandler : PSP_FILE_CALLBACK_A optional -> Ptr{Cvoid}
# Context : void* optional -> Ptr{Cvoid}
# stdcall は 32bit のみ意味を持つ(x64 では無視)。

local ffi = require("ffi")
ffi.cdef[[
int32_t SetupInstallFileA(
    void* InfHandle,
    void* InfContext,
    const char* SourceFile,
    const char* SourcePathRoot,
    const char* DestinationName,
    uint32_t CopyStyle,
    void* CopyMsgHandler,
    void* Context);
]]
local setupapi = ffi.load("setupapi")
-- setupapi.SetupInstallFileA(InfHandle, InfContext, SourceFile, SourcePathRoot, DestinationName, CopyStyle, CopyMsgHandler, Context)
-- InfHandle : void* optional
-- InfContext : INFCONTEXT* optional
-- SourceFile : LPCSTR optional
-- SourcePathRoot : LPCSTR optional
-- DestinationName : LPCSTR optional
-- CopyStyle : SP_COPY_STYLE
-- CopyMsgHandler : PSP_FILE_CALLBACK_A optional
-- Context : void* optional
-- 構造体/GUIDへのポインタは cdef が通るよう void* で表記(実型は各引数コメント参照)。値渡し構造体・enum は対応する typedef を cdef に追加すること。

const koffi = require('koffi');
const lib = koffi.load('SETUPAPI.dll');
const SetupInstallFileA = lib.func('__stdcall', 'SetupInstallFileA', 'int32_t', ['void *', 'void *', 'str', 'str', 'str', 'uint32_t', 'void *', 'void *']);
// SetupInstallFileA(InfHandle, InfContext, SourceFile, SourcePathRoot, DestinationName, CopyStyle, CopyMsgHandler, Context)
// InfHandle : void* optional -> 'void *'
// InfContext : INFCONTEXT* optional -> 'void *'
// SourceFile : LPCSTR optional -> 'str'
// SourcePathRoot : LPCSTR optional -> 'str'
// DestinationName : LPCSTR optional -> 'str'
// CopyStyle : SP_COPY_STYLE -> 'uint32_t'
// CopyMsgHandler : PSP_FILE_CALLBACK_A optional -> 'void *'
// Context : void* optional -> 'void *'
// 出力ポインタは koffi.out(...) で包む。構造体は koffi.struct で定義。
// コールバック(関数ポインタ)は koffi.proto/koffi.register で型を定義して渡す(素の void* では JS 関数を渡せない)。

const lib = Deno.dlopen("SETUPAPI.dll", {
  SetupInstallFileA: { parameters: ["pointer", "pointer", "buffer", "buffer", "buffer", "u32", "pointer", "pointer"], result: "i32" },
});
// lib.symbols.SetupInstallFileA(InfHandle, InfContext, SourceFile, SourcePathRoot, DestinationName, CopyStyle, CopyMsgHandler, Context)
// InfHandle : void* optional -> "pointer"
// InfContext : INFCONTEXT* optional -> "pointer"
// SourceFile : LPCSTR optional -> "buffer"
// SourcePathRoot : LPCSTR optional -> "buffer"
// DestinationName : LPCSTR optional -> "buffer"
// CopyStyle : SP_COPY_STYLE -> "u32"
// CopyMsgHandler : PSP_FILE_CALLBACK_A optional -> "pointer"
// Context : void* optional -> "pointer"
// 文字列は "buffer"。ANSI(-A) は new TextEncoder() で UTF-8/ANSI バイト列(末尾に \x00)を渡す。
// 値渡し構造体は { struct: [ ...field types... ] } を使用。

<?php
$ffi = FFI::cdef(<<<C
int32_t SetupInstallFileA(
    void* InfHandle,
    void* InfContext,
    const char* SourceFile,
    const char* SourcePathRoot,
    const char* DestinationName,
    uint32_t CopyStyle,
    void* CopyMsgHandler,
    void* Context);
C, "SETUPAPI.dll");
// $ffi->SetupInstallFileA(InfHandle, InfContext, SourceFile, SourcePathRoot, DestinationName, CopyStyle, CopyMsgHandler, Context);
// InfHandle : void* optional
// InfContext : INFCONTEXT* optional
// SourceFile : LPCSTR optional
// SourcePathRoot : LPCSTR optional
// DestinationName : LPCSTR optional
// CopyStyle : SP_COPY_STYLE
// CopyMsgHandler : PSP_FILE_CALLBACK_A optional
// Context : void* optional
// 構造体/GUIDへのポインタは cdef が通るよう void* で表記(実型は各引数コメント参照)。値渡し構造体・enum は対応する typedef を cdef に追加すること。
// WINAPI(stdcall): x64 では呼出規約が統一されるため問題なし。x86 では __stdcall 対応のラッパが必要な場合あり。

import com.sun.jna.*;
import com.sun.jna.ptr.*;
import com.sun.jna.win32.StdCallLibrary;
import com.sun.jna.win32.W32APIOptions;

public interface Setupapi extends StdCallLibrary {
    Setupapi INSTANCE = Native.load("setupapi", Setupapi.class, W32APIOptions.ASCII_OPTIONS);
    boolean SetupInstallFileA(
        Pointer InfHandle,   // void* optional
        Pointer InfContext,   // INFCONTEXT* optional
        String SourceFile,   // LPCSTR optional
        String SourcePathRoot,   // LPCSTR optional
        String DestinationName,   // LPCSTR optional
        int CopyStyle,   // SP_COPY_STYLE
        Callback CopyMsgHandler,   // PSP_FILE_CALLBACK_A optional
        Pointer Context   // void* optional
    );
}

@[Link("setupapi")]
lib LibSETUPAPI
  fun SetupInstallFileA = SetupInstallFileA(
    InfHandle : Void*,   # void* optional
    InfContext : INFCONTEXT*,   # INFCONTEXT* optional
    SourceFile : UInt8*,   # LPCSTR optional
    SourcePathRoot : UInt8*,   # LPCSTR optional
    DestinationName : UInt8*,   # LPCSTR optional
    CopyStyle : UInt32,   # SP_COPY_STYLE
    CopyMsgHandler : Void*,   # PSP_FILE_CALLBACK_A optional
    Context : Void*   # void* optional
  ) : Int32
end
# 構造体/GUID/enum は lib 内に対応する型定義が必要。
# 呼出規約: x64 は規約統一のため OK。x86(32bit)は WINAPI=stdcall だが Crystal の fun に stdcall 付与構文がなく非対応。

import 'dart:ffi';
import 'package:ffi/ffi.dart';

typedef SetupInstallFileANative = Int32 Function(Pointer<Void>, Pointer<Void>, Pointer<Utf8>, Pointer<Utf8>, Pointer<Utf8>, Uint32, Pointer<Void>, Pointer<Void>);
typedef SetupInstallFileADart = int Function(Pointer<Void>, Pointer<Void>, Pointer<Utf8>, Pointer<Utf8>, Pointer<Utf8>, int, Pointer<Void>, Pointer<Void>);
final SetupInstallFileA = DynamicLibrary.open('SETUPAPI.dll')
    .lookupFunction<SetupInstallFileANative, SetupInstallFileADart>('SetupInstallFileA');
// InfHandle : void* optional -> Pointer<Void>
// InfContext : INFCONTEXT* optional -> Pointer<Void>
// SourceFile : LPCSTR optional -> Pointer<Utf8>
// SourcePathRoot : LPCSTR optional -> Pointer<Utf8>
// DestinationName : LPCSTR optional -> Pointer<Utf8>
// CopyStyle : SP_COPY_STYLE -> Uint32
// CopyMsgHandler : PSP_FILE_CALLBACK_A optional -> Pointer<Void>
// Context : void* optional -> Pointer<Void>
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。

{$mode objfpc}{$H+}
function SetupInstallFileA(
  InfHandle: Pointer;   // void* optional
  InfContext: Pointer;   // INFCONTEXT* optional
  SourceFile: PAnsiChar;   // LPCSTR optional
  SourcePathRoot: PAnsiChar;   // LPCSTR optional
  DestinationName: PAnsiChar;   // LPCSTR optional
  CopyStyle: DWORD;   // SP_COPY_STYLE
  CopyMsgHandler: Pointer;   // PSP_FILE_CALLBACK_A optional
  Context: Pointer   // void* optional
): BOOL; stdcall;
  external 'SETUPAPI.dll' name 'SetupInstallFileA';

import Foreign
import Foreign.C.Types
import Foreign.C.String

foreign import stdcall safe "SetupInstallFileA"
  c_SetupInstallFileA :: Ptr () -> Ptr () -> CString -> CString -> CString -> Word32 -> Ptr () -> Ptr () -> IO CInt
-- InfHandle : void* optional -> Ptr ()
-- InfContext : INFCONTEXT* optional -> Ptr ()
-- SourceFile : LPCSTR optional -> CString
-- SourcePathRoot : LPCSTR optional -> CString
-- DestinationName : LPCSTR optional -> CString
-- CopyStyle : SP_COPY_STYLE -> Word32
-- CopyMsgHandler : PSP_FILE_CALLBACK_A optional -> Ptr ()
-- Context : void* optional -> Ptr ()
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。

open Ctypes
open Foreign

let setupinstallfilea =
  foreign "SetupInstallFileA"
    ((ptr void) @-> (ptr void) @-> string @-> string @-> string @-> uint32_t @-> (ptr void) @-> (ptr void) @-> returning int32_t)
(* InfHandle : void* optional -> (ptr void) *)
(* InfContext : INFCONTEXT* optional -> (ptr void) *)
(* SourceFile : LPCSTR optional -> string *)
(* SourcePathRoot : LPCSTR optional -> string *)
(* DestinationName : LPCSTR optional -> string *)
(* CopyStyle : SP_COPY_STYLE -> uint32_t *)
(* CopyMsgHandler : PSP_FILE_CALLBACK_A optional -> (ptr void) *)
(* Context : void* optional -> (ptr void) *)
(* foreign は cdecl 前提。x64 Windows では WINAPI と一致。構造体は ctypes structure を定義のこと。 *)

(cffi:define-foreign-library setupapi (t "SETUPAPI.dll"))
(cffi:use-foreign-library setupapi)

(cffi:defcfun ("SetupInstallFileA" setup-install-file-a :convention :stdcall) :int32
  (inf-handle :pointer)   ; void* optional
  (inf-context :pointer)   ; INFCONTEXT* optional
  (source-file :string)   ; LPCSTR optional
  (source-path-root :string)   ; LPCSTR optional
  (destination-name :string)   ; LPCSTR optional
  (copy-style :uint32)   ; SP_COPY_STYLE
  (copy-msg-handler :pointer)   ; PSP_FILE_CALLBACK_A optional
  (context :pointer))   ; void* optional
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。

use Win32::API;
my $SetupInstallFileA = Win32::API::More->new('SETUPAPI',
    'BOOL SetupInstallFileA(LPVOID InfHandle, LPVOID InfContext, LPCSTR SourceFile, LPCSTR SourcePathRoot, LPCSTR DestinationName, DWORD CopyStyle, LPVOID CopyMsgHandler, LPVOID Context)');
# my $ret = $SetupInstallFileA->Call($InfHandle, $InfContext, $SourceFile, $SourcePathRoot, $DestinationName, $CopyStyle, $CopyMsgHandler, $Context);
# InfHandle : void* optional -> LPVOID
# InfContext : INFCONTEXT* optional -> LPVOID
# SourceFile : LPCSTR optional -> LPCSTR
# SourcePathRoot : LPCSTR optional -> LPCSTR
# DestinationName : LPCSTR optional -> LPCSTR
# CopyStyle : SP_COPY_STYLE -> DWORD
# CopyMsgHandler : PSP_FILE_CALLBACK_A optional -> LPVOID
# Context : void* optional -> LPVOID
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。
# コールバック(関数ポインタ)は Perl sub を直接渡せません。Win32::API::Callback を使用してください。

SetupInstallFileA

シグネチャ

パラメーター

公式ドキュメント

戻り値

解説(Remarks)

各言語での呼び出し定義

関連項目