ReplaceFileA
関数シグネチャ
// KERNEL32.dll (ANSI / -A)
#include <windows.h>
BOOL ReplaceFileA(
LPCSTR lpReplacedFileName,
LPCSTR lpReplacementFileName,
LPCSTR lpBackupFileName, // optional
REPLACE_FILE_FLAGS dwReplaceFlags,
void* lpExclude, // optional
void* lpReserved // optional
);パラメーター
| 名前 | 型 | 方向 | 説明 | ||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|
| lpReplacedFileName | LPCSTR | in | 置き換えられるファイルの名前です。 既定では、名前は MAX_PATH 文字に制限されます。この制限を 32,767 ワイド文字まで拡張するには、パスの先頭に "\\?\" を付加します。詳細については、ファイル、パス、および名前空間の名前付けを参照してください。 ヒント
Windows 10 バージョン 1607 以降では、"\\?\" を付加せずに MAX_PATH の制限を解除するオプトインが可能です。詳細については、ファイル、パス、および名前空間の名前付けの「Maximum Path Length Limitation」セクションを参照してください。 このファイルは GENERIC_READ、DELETE、および SYNCHRONIZE アクセス権で開かれます。共有モードは FILE_SHARE_READ | FILE_SHARE_WRITE | FILE_SHARE_DELETE です。 呼び出し元は、置き換えられるファイルへの書き込みアクセス権を持っている必要があります。詳細については、 File Security and Access Rights を参照してください。 | ||||||||
| lpReplacementFileName | LPCSTR | in | lpReplacedFileName ファイルを置き換えるファイルの名前です。 既定では、名前は MAX_PATH 文字に制限されます。この制限を 32,767 ワイド文字まで拡張するには、パスの先頭に "\\?\" を付加します。詳細については、ファイル、パス、および名前空間の名前付けを参照してください。 ヒント
Windows 10 バージョン 1607 以降では、"\\?\" を付加せずに MAX_PATH の制限を解除するオプトインが可能です。詳細については、ファイル、パス、および名前空間の名前付けの「Maximum Path Length Limitation」セクションを参照してください。 この関数は、すべての属性と ACL を保持できるように、SYNCHRONIZE、 GENERIC_READ、GENERIC_WRITE、 DELETE、および WRITE_DAC アクセス権でこのファイルを開こうとします。これに失敗した場合、関数は SYNCHRONIZE、GENERIC_READ、 DELETE、および WRITE_DAC アクセス権でファイルを開こうとします。共有モードは 指定されません。 | ||||||||
| lpBackupFileName | LPCSTR | inoptional | lpReplacedFileName ファイルのバックアップコピーとして機能するファイルの名前です。このパラメーターが NULL の場合、バックアップファイルは作成されません。バックアップファイルの実装の詳細については、「解説」セクションを参照してください。 既定では、名前は MAX_PATH 文字に制限されます。この制限を 32,767 ワイド文字まで拡張するには、パスの先頭に "\\?\" を付加します。詳細については、ファイル、パス、および名前空間の名前付けを参照してください。 ヒント
Windows 10 バージョン 1607 以降では、"\\?\" を付加せずに MAX_PATH の制限を解除するオプトインが可能です。詳細については、ファイル、パス、および名前空間の名前付けの「Maximum Path Length Limitation」セクションを参照してください。 | ||||||||
| dwReplaceFlags | REPLACE_FILE_FLAGS | in | 置き換えのオプションです。このパラメーターには、次の値のうち 1 つ以上を指定できます。
| ||||||||
| lpExclude | void* | optional | 将来の使用のために予約されています。 | ||||||||
| lpReserved | void* | optional | 将来の使用のために予約されています。 |
戻り値の型: BOOL
公式ドキュメント
あるファイルを別のファイルで置き換えます。元のファイルのバックアップコピーを作成するオプションがあります。(ANSI)
戻り値
関数が成功すると、戻り値は 0 以外になります。
関数が失敗すると、戻り値は 0 になります。拡張エラー情報を取得するには、 GetLastError を呼び出します。この関数で発生し得るエラーコードは 次のとおりです。
| 戻り値/値 | 説明 |
|---|---|
|
置き換えるファイルの名前を変更できませんでした。lpBackupFileName が指定されていた場合、 置き換えられるファイルと置き換えるファイルは元のファイル名を保持します。それ以外の場合、置き換えられるファイルはもはや 存在せず、置き換えるファイルが元の名前で存在します。 |
|
置き換えるファイルを移動できませんでした。置き換えるファイルは元の名前のまま存在しますが、 置き換え対象のファイルからファイルストリームと属性を継承しています。置き換えられるファイルは 別の名前で引き続き存在します。lpBackupFileName が指定されている場合、それが 置き換えられたファイルの名前になります。 |
|
置き換えられるファイルを削除できませんでした。置き換えられるファイルと置き換えるファイルは元のファイル 名を保持します。 |
ERROR_INVALID_PARAMETER などのその他のエラーが返された場合、置き換えられるファイルと 置き換えるファイルは元のファイル名を保持します。このシナリオでは、バックアップファイルは 存在せず、置き換えるファイルが置き換えられるファイルのすべての属性とストリームを 継承しているとは保証されません。
解説(Remarks)
- 作成時刻
- 短いファイル名
- オブジェクト識別子
- DACL
- セキュリティリソース属性
- 暗号化
- 圧縮
- 置き換えるファイルにまだ存在しない名前付きストリーム
Windows 7、Windows Server 2008 R2、Windows Server 2008、Windows Vista、Windows Server 2003 および Windows XP: 元のファイルのセキュリティリソース属性(ATTRIBUTE_SECURITY_INFORMATION)は、Windows 8 および Windows Server 2012 まで 保持されません。
置き換えるファイルが Selective Wipe を使用して保護されている場合、置き換えられるファイルは置き換えるファイルのエンタープライズ ID によって保護されます。
バックアップファイル、置き換えられるファイル、および置き換えるファイルは、すべて同じボリューム上に存在する必要があります。
ファイルを削除または名前変更するには、そのファイルに対する削除アクセス許可、または親ディレクトリに対する子の削除アクセス許可のいずれかが必要です。削除および子の削除を除くすべてのアクセスを持つディレクトリを設定し、 新しいファイルの DACL が継承される場合、ファイルを削除できないままファイルを作成できるはずです。ただし、 ファイルを作成すると、作成時に返されたハンドルに対して要求したすべてのアクセス権が得られます。ファイル作成時に削除アクセス許可を要求した場合は、そのハンドルでファイルを削除または名前変更できますが、他のハンドルではできません。
winbase.h ヘッダーは ReplaceFile を、UNICODE プリプロセッサ定数の定義に基づいてこの関数の ANSI 版または Unicode 版を自動的に選択するエイリアスとして定義しています。エンコーディング中立のエイリアスの使用と、エンコーディング中立でないコードを混在させると、コンパイルエラーまたは実行時エラーを引き起こす不一致につながる可能性があります。詳細については、関数プロトタイプの規則を参照してください。
Microsoft 公式リファレンス: 英語 (en-us) · 日本語 (ja-jp) · 原文ソース (GitHub)
各言語での呼び出し定義
// KERNEL32.dll (ANSI / -A)
#include <windows.h>
BOOL ReplaceFileA(
LPCSTR lpReplacedFileName,
LPCSTR lpReplacementFileName,
LPCSTR lpBackupFileName, // optional
REPLACE_FILE_FLAGS dwReplaceFlags,
void* lpExclude, // optional
void* lpReserved // optional
);[return: MarshalAs(UnmanagedType.Bool)]
[DllImport("KERNEL32.dll", CharSet = CharSet.Ansi, SetLastError = true, ExactSpelling = true)]
static extern bool ReplaceFileA(
[MarshalAs(UnmanagedType.LPStr)] string lpReplacedFileName, // LPCSTR
[MarshalAs(UnmanagedType.LPStr)] string lpReplacementFileName, // LPCSTR
[MarshalAs(UnmanagedType.LPStr)] string lpBackupFileName, // LPCSTR optional
uint dwReplaceFlags, // REPLACE_FILE_FLAGS
IntPtr lpExclude, // void* optional
IntPtr lpReserved // void* optional
);<DllImport("KERNEL32.dll", CharSet:=CharSet.Ansi, SetLastError:=True, ExactSpelling:=True)>
Public Shared Function ReplaceFileA(
<MarshalAs(UnmanagedType.LPStr)> lpReplacedFileName As String, ' LPCSTR
<MarshalAs(UnmanagedType.LPStr)> lpReplacementFileName As String, ' LPCSTR
<MarshalAs(UnmanagedType.LPStr)> lpBackupFileName As String, ' LPCSTR optional
dwReplaceFlags As UInteger, ' REPLACE_FILE_FLAGS
lpExclude As IntPtr, ' void* optional
lpReserved As IntPtr ' void* optional
) As <MarshalAs(UnmanagedType.Bool)> Boolean
End Function' lpReplacedFileName : LPCSTR
' lpReplacementFileName : LPCSTR
' lpBackupFileName : LPCSTR optional
' dwReplaceFlags : REPLACE_FILE_FLAGS
' lpExclude : void* optional
' lpReserved : void* optional
Declare PtrSafe Function ReplaceFileA Lib "kernel32" ( _
ByVal lpReplacedFileName As String, _
ByVal lpReplacementFileName As String, _
ByVal lpBackupFileName As String, _
ByVal dwReplaceFlags As Long, _
ByVal lpExclude As LongPtr, _
ByVal lpReserved As LongPtr) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。import ctypes
from ctypes import wintypes
ReplaceFileA = ctypes.windll.kernel32.ReplaceFileA
ReplaceFileA.restype = wintypes.BOOL
ReplaceFileA.argtypes = [
wintypes.LPCSTR, # lpReplacedFileName : LPCSTR
wintypes.LPCSTR, # lpReplacementFileName : LPCSTR
wintypes.LPCSTR, # lpBackupFileName : LPCSTR optional
wintypes.DWORD, # dwReplaceFlags : REPLACE_FILE_FLAGS
ctypes.POINTER(None), # lpExclude : void* optional
ctypes.POINTER(None), # lpReserved : void* optional
]
# GetLastError: use ctypes.GetLastError() (or ctypes.WinDLL(use_last_error=True))require 'fiddle'
require 'fiddle/import'
lib = Fiddle.dlopen('KERNEL32.dll')
ReplaceFileA = Fiddle::Function.new(
lib['ReplaceFileA'],
[
Fiddle::TYPE_VOIDP, # lpReplacedFileName : LPCSTR
Fiddle::TYPE_VOIDP, # lpReplacementFileName : LPCSTR
Fiddle::TYPE_VOIDP, # lpBackupFileName : LPCSTR optional
-Fiddle::TYPE_INT, # dwReplaceFlags : REPLACE_FILE_FLAGS
Fiddle::TYPE_VOIDP, # lpExclude : void* optional
Fiddle::TYPE_VOIDP, # lpReserved : void* optional
],
Fiddle::TYPE_INT)#[link(name = "kernel32")]
extern "system" {
fn ReplaceFileA(
lpReplacedFileName: *const u8, // LPCSTR
lpReplacementFileName: *const u8, // LPCSTR
lpBackupFileName: *const u8, // LPCSTR optional
dwReplaceFlags: u32, // REPLACE_FILE_FLAGS
lpExclude: *mut (), // void* optional
lpReserved: *mut () // void* optional
) -> i32;
}
// crates: windows-sys provides ready-made bindings for this API.$sig = @"
[return: MarshalAs(UnmanagedType.Bool)]
[DllImport("KERNEL32.dll", CharSet = CharSet.Ansi, SetLastError = true)]
public static extern bool ReplaceFileA([MarshalAs(UnmanagedType.LPStr)] string lpReplacedFileName, [MarshalAs(UnmanagedType.LPStr)] string lpReplacementFileName, [MarshalAs(UnmanagedType.LPStr)] string lpBackupFileName, uint dwReplaceFlags, IntPtr lpExclude, IntPtr lpReserved);
"@
$api = Add-Type -MemberDefinition $sig -Name 'KERNEL32_ReplaceFileA' -Namespace Win32 -PassThru
# $api::ReplaceFileA(lpReplacedFileName, lpReplacementFileName, lpBackupFileName, dwReplaceFlags, lpExclude, lpReserved)#uselib "KERNEL32.dll"
#func global ReplaceFileA "ReplaceFileA" sptr, sptr, sptr, sptr, sptr, sptr
; ReplaceFileA lpReplacedFileName, lpReplacementFileName, lpBackupFileName, dwReplaceFlags, lpExclude, lpReserved ; 戻り値は stat
; lpReplacedFileName : LPCSTR -> "sptr"
; lpReplacementFileName : LPCSTR -> "sptr"
; lpBackupFileName : LPCSTR optional -> "sptr"
; dwReplaceFlags : REPLACE_FILE_FLAGS -> "sptr"
; lpExclude : void* optional -> "sptr"
; lpReserved : void* optional -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。#uselib "KERNEL32.dll"
#cfunc global ReplaceFileA "ReplaceFileA" str, str, str, int, sptr, sptr
; res = ReplaceFileA(lpReplacedFileName, lpReplacementFileName, lpBackupFileName, dwReplaceFlags, lpExclude, lpReserved)
; lpReplacedFileName : LPCSTR -> "str"
; lpReplacementFileName : LPCSTR -> "str"
; lpBackupFileName : LPCSTR optional -> "str"
; dwReplaceFlags : REPLACE_FILE_FLAGS -> "int"
; lpExclude : void* optional -> "sptr"
; lpReserved : void* optional -> "sptr"; BOOL ReplaceFileA(LPCSTR lpReplacedFileName, LPCSTR lpReplacementFileName, LPCSTR lpBackupFileName, REPLACE_FILE_FLAGS dwReplaceFlags, void* lpExclude, void* lpReserved)
#uselib "KERNEL32.dll"
#cfunc global ReplaceFileA "ReplaceFileA" str, str, str, int, intptr, intptr
; res = ReplaceFileA(lpReplacedFileName, lpReplacementFileName, lpBackupFileName, dwReplaceFlags, lpExclude, lpReserved)
; lpReplacedFileName : LPCSTR -> "str"
; lpReplacementFileName : LPCSTR -> "str"
; lpBackupFileName : LPCSTR optional -> "str"
; dwReplaceFlags : REPLACE_FILE_FLAGS -> "int"
; lpExclude : void* optional -> "intptr"
; lpReserved : void* optional -> "intptr"import (
"golang.org/x/sys/windows"
"unsafe"
)
var (
kernel32 = windows.NewLazySystemDLL("KERNEL32.dll")
procReplaceFileA = kernel32.NewProc("ReplaceFileA")
)
// lpReplacedFileName (LPCSTR), lpReplacementFileName (LPCSTR), lpBackupFileName (LPCSTR optional), dwReplaceFlags (REPLACE_FILE_FLAGS), lpExclude (void* optional), lpReserved (void* optional)
r1, _, err := procReplaceFileA.Call(
uintptr(unsafe.Pointer(windows.BytePtrFromString(lpReplacedFileName))),
uintptr(unsafe.Pointer(windows.BytePtrFromString(lpReplacementFileName))),
uintptr(unsafe.Pointer(windows.BytePtrFromString(lpBackupFileName))),
uintptr(dwReplaceFlags),
uintptr(lpExclude),
uintptr(lpReserved),
)
_ = err // syscall.Errno (valid when the call sets last-error)
_ = r1 // BOOLfunction ReplaceFileA(
lpReplacedFileName: PAnsiChar; // LPCSTR
lpReplacementFileName: PAnsiChar; // LPCSTR
lpBackupFileName: PAnsiChar; // LPCSTR optional
dwReplaceFlags: DWORD; // REPLACE_FILE_FLAGS
lpExclude: Pointer; // void* optional
lpReserved: Pointer // void* optional
): BOOL; stdcall;
external 'KERNEL32.dll' name 'ReplaceFileA';result := DllCall("KERNEL32\ReplaceFileA"
, "AStr", lpReplacedFileName ; LPCSTR
, "AStr", lpReplacementFileName ; LPCSTR
, "AStr", lpBackupFileName ; LPCSTR optional
, "UInt", dwReplaceFlags ; REPLACE_FILE_FLAGS
, "Ptr", lpExclude ; void* optional
, "Ptr", lpReserved ; void* optional
, "Int") ; return: BOOL●ReplaceFileA(lpReplacedFileName, lpReplacementFileName, lpBackupFileName, dwReplaceFlags, lpExclude, lpReserved) = DLL("KERNEL32.dll", "bool ReplaceFileA(char*, char*, char*, dword, void*, void*)")
# 呼び出し: ReplaceFileA(lpReplacedFileName, lpReplacementFileName, lpBackupFileName, dwReplaceFlags, lpExclude, lpReserved)
# lpReplacedFileName : LPCSTR -> "char*"
# lpReplacementFileName : LPCSTR -> "char*"
# lpBackupFileName : LPCSTR optional -> "char*"
# dwReplaceFlags : REPLACE_FILE_FLAGS -> "dword"
# lpExclude : void* optional -> "void*"
# lpReserved : void* optional -> "void*"
# なでしこ1は32bit・ANSI(Shift_JIS)。文字列=char*(ANSI)、ポインタ/ハンドル=void*(4byte)。const std = @import("std");
extern "kernel32" fn ReplaceFileA(
lpReplacedFileName: [*c]const u8, // LPCSTR
lpReplacementFileName: [*c]const u8, // LPCSTR
lpBackupFileName: [*c]const u8, // LPCSTR optional
dwReplaceFlags: u32, // REPLACE_FILE_FLAGS
lpExclude: ?*anyopaque, // void* optional
lpReserved: ?*anyopaque // void* optional
) callconv(std.os.windows.WINAPI) i32;proc ReplaceFileA(
lpReplacedFileName: cstring, # LPCSTR
lpReplacementFileName: cstring, # LPCSTR
lpBackupFileName: cstring, # LPCSTR optional
dwReplaceFlags: uint32, # REPLACE_FILE_FLAGS
lpExclude: pointer, # void* optional
lpReserved: pointer # void* optional
): int32 {.importc: "ReplaceFileA", stdcall, dynlib: "KERNEL32.dll".}pragma(lib, "kernel32");
extern(Windows)
int ReplaceFileA(
const(char)* lpReplacedFileName, // LPCSTR
const(char)* lpReplacementFileName, // LPCSTR
const(char)* lpBackupFileName, // LPCSTR optional
uint dwReplaceFlags, // REPLACE_FILE_FLAGS
void* lpExclude, // void* optional
void* lpReserved // void* optional
);ccall((:ReplaceFileA, "KERNEL32.dll"), stdcall, Int32,
(Cstring, Cstring, Cstring, UInt32, Ptr{Cvoid}, Ptr{Cvoid}),
lpReplacedFileName, lpReplacementFileName, lpBackupFileName, dwReplaceFlags, lpExclude, lpReserved)
# lpReplacedFileName : LPCSTR -> Cstring
# lpReplacementFileName : LPCSTR -> Cstring
# lpBackupFileName : LPCSTR optional -> Cstring
# dwReplaceFlags : REPLACE_FILE_FLAGS -> UInt32
# lpExclude : void* optional -> Ptr{Cvoid}
# lpReserved : void* optional -> Ptr{Cvoid}
# stdcall は 32bit のみ意味を持つ(x64 では無視)。local ffi = require("ffi")
ffi.cdef[[
int32_t ReplaceFileA(
const char* lpReplacedFileName,
const char* lpReplacementFileName,
const char* lpBackupFileName,
uint32_t dwReplaceFlags,
void* lpExclude,
void* lpReserved);
]]
local kernel32 = ffi.load("kernel32")
-- kernel32.ReplaceFileA(lpReplacedFileName, lpReplacementFileName, lpBackupFileName, dwReplaceFlags, lpExclude, lpReserved)
-- lpReplacedFileName : LPCSTR
-- lpReplacementFileName : LPCSTR
-- lpBackupFileName : LPCSTR optional
-- dwReplaceFlags : REPLACE_FILE_FLAGS
-- lpExclude : void* optional
-- lpReserved : void* optional
-- 構造体/GUIDへのポインタは cdef が通るよう void* で表記(実型は各引数コメント参照)。値渡し構造体・enum は対応する typedef を cdef に追加すること。const koffi = require('koffi');
const lib = koffi.load('KERNEL32.dll');
const ReplaceFileA = lib.func('__stdcall', 'ReplaceFileA', 'int32_t', ['str', 'str', 'str', 'uint32_t', 'void *', 'void *']);
// ReplaceFileA(lpReplacedFileName, lpReplacementFileName, lpBackupFileName, dwReplaceFlags, lpExclude, lpReserved)
// lpReplacedFileName : LPCSTR -> 'str'
// lpReplacementFileName : LPCSTR -> 'str'
// lpBackupFileName : LPCSTR optional -> 'str'
// dwReplaceFlags : REPLACE_FILE_FLAGS -> 'uint32_t'
// lpExclude : void* optional -> 'void *'
// lpReserved : void* optional -> 'void *'
// 出力ポインタは koffi.out(...) で包む。構造体は koffi.struct で定義。const lib = Deno.dlopen("KERNEL32.dll", {
ReplaceFileA: { parameters: ["buffer", "buffer", "buffer", "u32", "pointer", "pointer"], result: "i32" },
});
// lib.symbols.ReplaceFileA(lpReplacedFileName, lpReplacementFileName, lpBackupFileName, dwReplaceFlags, lpExclude, lpReserved)
// lpReplacedFileName : LPCSTR -> "buffer"
// lpReplacementFileName : LPCSTR -> "buffer"
// lpBackupFileName : LPCSTR optional -> "buffer"
// dwReplaceFlags : REPLACE_FILE_FLAGS -> "u32"
// lpExclude : void* optional -> "pointer"
// lpReserved : void* optional -> "pointer"
// 文字列は "buffer"。ANSI(-A) は new TextEncoder() で UTF-8/ANSI バイト列(末尾に \x00)を渡す。
// 値渡し構造体は { struct: [ ...field types... ] } を使用。<?php
$ffi = FFI::cdef(<<<C
int32_t ReplaceFileA(
const char* lpReplacedFileName,
const char* lpReplacementFileName,
const char* lpBackupFileName,
uint32_t dwReplaceFlags,
void* lpExclude,
void* lpReserved);
C, "KERNEL32.dll");
// $ffi->ReplaceFileA(lpReplacedFileName, lpReplacementFileName, lpBackupFileName, dwReplaceFlags, lpExclude, lpReserved);
// lpReplacedFileName : LPCSTR
// lpReplacementFileName : LPCSTR
// lpBackupFileName : LPCSTR optional
// dwReplaceFlags : REPLACE_FILE_FLAGS
// lpExclude : void* optional
// lpReserved : 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 Kernel32 extends StdCallLibrary {
Kernel32 INSTANCE = Native.load("kernel32", Kernel32.class, W32APIOptions.ASCII_OPTIONS);
boolean ReplaceFileA(
String lpReplacedFileName, // LPCSTR
String lpReplacementFileName, // LPCSTR
String lpBackupFileName, // LPCSTR optional
int dwReplaceFlags, // REPLACE_FILE_FLAGS
Pointer lpExclude, // void* optional
Pointer lpReserved // void* optional
);
}@[Link("kernel32")]
lib LibKERNEL32
fun ReplaceFileA = ReplaceFileA(
lpReplacedFileName : UInt8*, # LPCSTR
lpReplacementFileName : UInt8*, # LPCSTR
lpBackupFileName : UInt8*, # LPCSTR optional
dwReplaceFlags : UInt32, # REPLACE_FILE_FLAGS
lpExclude : Void*, # void* optional
lpReserved : 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 ReplaceFileANative = Int32 Function(Pointer<Utf8>, Pointer<Utf8>, Pointer<Utf8>, Uint32, Pointer<Void>, Pointer<Void>);
typedef ReplaceFileADart = int Function(Pointer<Utf8>, Pointer<Utf8>, Pointer<Utf8>, int, Pointer<Void>, Pointer<Void>);
final ReplaceFileA = DynamicLibrary.open('KERNEL32.dll')
.lookupFunction<ReplaceFileANative, ReplaceFileADart>('ReplaceFileA');
// lpReplacedFileName : LPCSTR -> Pointer<Utf8>
// lpReplacementFileName : LPCSTR -> Pointer<Utf8>
// lpBackupFileName : LPCSTR optional -> Pointer<Utf8>
// dwReplaceFlags : REPLACE_FILE_FLAGS -> Uint32
// lpExclude : void* optional -> Pointer<Void>
// lpReserved : void* optional -> Pointer<Void>
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。{$mode objfpc}{$H+}
function ReplaceFileA(
lpReplacedFileName: PAnsiChar; // LPCSTR
lpReplacementFileName: PAnsiChar; // LPCSTR
lpBackupFileName: PAnsiChar; // LPCSTR optional
dwReplaceFlags: DWORD; // REPLACE_FILE_FLAGS
lpExclude: Pointer; // void* optional
lpReserved: Pointer // void* optional
): BOOL; stdcall;
external 'KERNEL32.dll' name 'ReplaceFileA';import Foreign
import Foreign.C.Types
import Foreign.C.String
foreign import stdcall safe "ReplaceFileA"
c_ReplaceFileA :: CString -> CString -> CString -> Word32 -> Ptr () -> Ptr () -> IO CInt
-- lpReplacedFileName : LPCSTR -> CString
-- lpReplacementFileName : LPCSTR -> CString
-- lpBackupFileName : LPCSTR optional -> CString
-- dwReplaceFlags : REPLACE_FILE_FLAGS -> Word32
-- lpExclude : void* optional -> Ptr ()
-- lpReserved : void* optional -> Ptr ()
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。open Ctypes
open Foreign
let replacefilea =
foreign "ReplaceFileA"
(string @-> string @-> string @-> uint32_t @-> (ptr void) @-> (ptr void) @-> returning int32_t)
(* lpReplacedFileName : LPCSTR -> string *)
(* lpReplacementFileName : LPCSTR -> string *)
(* lpBackupFileName : LPCSTR optional -> string *)
(* dwReplaceFlags : REPLACE_FILE_FLAGS -> uint32_t *)
(* lpExclude : void* optional -> (ptr void) *)
(* lpReserved : void* optional -> (ptr void) *)
(* foreign は cdecl 前提。x64 Windows では WINAPI と一致。構造体は ctypes structure を定義のこと。 *)(cffi:define-foreign-library kernel32 (t "KERNEL32.dll"))
(cffi:use-foreign-library kernel32)
(cffi:defcfun ("ReplaceFileA" replace-file-a :convention :stdcall) :int32
(lp-replaced-file-name :string) ; LPCSTR
(lp-replacement-file-name :string) ; LPCSTR
(lp-backup-file-name :string) ; LPCSTR optional
(dw-replace-flags :uint32) ; REPLACE_FILE_FLAGS
(lp-exclude :pointer) ; void* optional
(lp-reserved :pointer)) ; void* optional
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。use Win32::API;
my $ReplaceFileA = Win32::API::More->new('KERNEL32',
'BOOL ReplaceFileA(LPCSTR lpReplacedFileName, LPCSTR lpReplacementFileName, LPCSTR lpBackupFileName, DWORD dwReplaceFlags, LPVOID lpExclude, LPVOID lpReserved)');
# my $ret = $ReplaceFileA->Call($lpReplacedFileName, $lpReplacementFileName, $lpBackupFileName, $dwReplaceFlags, $lpExclude, $lpReserved);
# lpReplacedFileName : LPCSTR -> LPCSTR
# lpReplacementFileName : LPCSTR -> LPCSTR
# lpBackupFileName : LPCSTR optional -> LPCSTR
# dwReplaceFlags : REPLACE_FILE_FLAGS -> DWORD
# lpExclude : void* optional -> LPVOID
# lpReserved : void* optional -> LPVOID
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。関連項目
- f ReplaceFileW (Unicode版) — 対象ファイルを別ファイルで置換しバックアップを残す(Unicode版)。
- f CopyFileExA — 進捗通知付きでファイルをコピーする(ANSI版)。
- f MoveFileExA — フラグ指定でファイルを移動・改名する(ANSI版)。
- f MoveFileWithProgressA — 進捗通知付きでファイルを移動・改名する(ANSI版)。