ReplaceFileA

関数

対象ファイルを別ファイルで置換しバックアップを残す(ANSI版)。

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

シグネチャ

// 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
lpReplacementFileName	LPCSTR	in
lpBackupFileName	LPCSTR	inoptional
dwReplaceFlags	REPLACE_FILE_FLAGS	in
lpExclude	void*	optional
lpReserved	void*	optional

戻り値の型: BOOL

各言語での呼び出し定義

// 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 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   // BOOL

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';

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)。