ReplaceFileW

関数

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

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

シグネチャ

// KERNEL32.dll  (Unicode / -W)
#include <windows.h>

BOOL ReplaceFileW(
    LPCWSTR lpReplacedFileName,
    LPCWSTR lpReplacementFileName,
    LPCWSTR lpBackupFileName,   // optional
    REPLACE_FILE_FLAGS dwReplaceFlags,
    void* lpExclude,   // optional
    void* lpReserved   // optional
);

パラメーター

名前	型	方向
lpReplacedFileName	LPCWSTR	in
lpReplacementFileName	LPCWSTR	in
lpBackupFileName	LPCWSTR	inoptional
dwReplaceFlags	REPLACE_FILE_FLAGS	in
lpExclude	void*	optional
lpReserved	void*	optional

戻り値の型: BOOL

各言語での呼び出し定義

// KERNEL32.dll  (Unicode / -W)
#include <windows.h>

BOOL ReplaceFileW(
    LPCWSTR lpReplacedFileName,
    LPCWSTR lpReplacementFileName,
    LPCWSTR lpBackupFileName,   // optional
    REPLACE_FILE_FLAGS dwReplaceFlags,
    void* lpExclude,   // optional
    void* lpReserved   // optional
);

[return: MarshalAs(UnmanagedType.Bool)]
[DllImport("KERNEL32.dll", CharSet = CharSet.Unicode, SetLastError = true, ExactSpelling = true)]
static extern bool ReplaceFileW(
    [MarshalAs(UnmanagedType.LPWStr)] string lpReplacedFileName,   // LPCWSTR
    [MarshalAs(UnmanagedType.LPWStr)] string lpReplacementFileName,   // LPCWSTR
    [MarshalAs(UnmanagedType.LPWStr)] string lpBackupFileName,   // LPCWSTR optional
    uint dwReplaceFlags,   // REPLACE_FILE_FLAGS
    IntPtr lpExclude,   // void* optional
    IntPtr lpReserved   // void* optional
);

<DllImport("KERNEL32.dll", CharSet:=CharSet.Unicode, SetLastError:=True, ExactSpelling:=True)>
Public Shared Function ReplaceFileW(
    <MarshalAs(UnmanagedType.LPWStr)> lpReplacedFileName As String,   ' LPCWSTR
    <MarshalAs(UnmanagedType.LPWStr)> lpReplacementFileName As String,   ' LPCWSTR
    <MarshalAs(UnmanagedType.LPWStr)> lpBackupFileName As String,   ' LPCWSTR optional
    dwReplaceFlags As UInteger,   ' REPLACE_FILE_FLAGS
    lpExclude As IntPtr,   ' void* optional
    lpReserved As IntPtr   ' void* optional
) As Boolean
End Function

' lpReplacedFileName : LPCWSTR
' lpReplacementFileName : LPCWSTR
' lpBackupFileName : LPCWSTR optional
' dwReplaceFlags : REPLACE_FILE_FLAGS
' lpExclude : void* optional
' lpReserved : void* optional
Declare PtrSafe Function ReplaceFileW Lib "kernel32" ( _
    ByVal lpReplacedFileName As LongPtr, _
    ByVal lpReplacementFileName As LongPtr, _
    ByVal lpBackupFileName As LongPtr, _
    ByVal dwReplaceFlags As Long, _
    ByVal lpExclude As LongPtr, _
    ByVal lpReserved As LongPtr) As Long
' Unicode(W): 文字列は ByVal As LongPtr とし StrPtr(unicodeStr) を渡す
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。

import ctypes
from ctypes import wintypes

ReplaceFileW = ctypes.windll.kernel32.ReplaceFileW
ReplaceFileW.restype = wintypes.BOOL
ReplaceFileW.argtypes = [
    wintypes.LPCWSTR,  # lpReplacedFileName : LPCWSTR
    wintypes.LPCWSTR,  # lpReplacementFileName : LPCWSTR
    wintypes.LPCWSTR,  # lpBackupFileName : LPCWSTR 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')
ReplaceFileW = Fiddle::Function.new(
  lib['ReplaceFileW'],
  [
    Fiddle::TYPE_VOIDP,  # lpReplacedFileName : LPCWSTR
    Fiddle::TYPE_VOIDP,  # lpReplacementFileName : LPCWSTR
    Fiddle::TYPE_VOIDP,  # lpBackupFileName : LPCWSTR optional
    -Fiddle::TYPE_INT,  # dwReplaceFlags : REPLACE_FILE_FLAGS
    Fiddle::TYPE_VOIDP,  # lpExclude : void* optional
    Fiddle::TYPE_VOIDP,  # lpReserved : void* optional
  ],
  Fiddle::TYPE_INT)
# Wide strings: pass str.encode("UTF-16LE") + "\x00\x00"

#[link(name = "kernel32")]
extern "system" {
    fn ReplaceFileW(
        lpReplacedFileName: *const u16,  // LPCWSTR
        lpReplacementFileName: *const u16,  // LPCWSTR
        lpBackupFileName: *const u16,  // LPCWSTR 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.Unicode, SetLastError = true)]
public static extern bool ReplaceFileW([MarshalAs(UnmanagedType.LPWStr)] string lpReplacedFileName, [MarshalAs(UnmanagedType.LPWStr)] string lpReplacementFileName, [MarshalAs(UnmanagedType.LPWStr)] string lpBackupFileName, uint dwReplaceFlags, IntPtr lpExclude, IntPtr lpReserved);
"@
$api = Add-Type -MemberDefinition $sig -Name 'KERNEL32_ReplaceFileW' -Namespace Win32 -PassThru
# $api::ReplaceFileW(lpReplacedFileName, lpReplacementFileName, lpBackupFileName, dwReplaceFlags, lpExclude, lpReserved)

#uselib "KERNEL32.dll"
#func global ReplaceFileW "ReplaceFileW" wptr, wptr, wptr, wptr, wptr, wptr
; ReplaceFileW lpReplacedFileName, lpReplacementFileName, lpBackupFileName, dwReplaceFlags, lpExclude, lpReserved   ; 戻り値は stat
; lpReplacedFileName : LPCWSTR -> "wptr"
; lpReplacementFileName : LPCWSTR -> "wptr"
; lpBackupFileName : LPCWSTR optional -> "wptr"
; dwReplaceFlags : REPLACE_FILE_FLAGS -> "wptr"
; lpExclude : void* optional -> "wptr"
; lpReserved : void* optional -> "wptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。

#uselib "KERNEL32.dll"
#cfunc global ReplaceFileW "ReplaceFileW" wstr, wstr, wstr, int, sptr, sptr
; res = ReplaceFileW(lpReplacedFileName, lpReplacementFileName, lpBackupFileName, dwReplaceFlags, lpExclude, lpReserved)
; lpReplacedFileName : LPCWSTR -> "wstr"
; lpReplacementFileName : LPCWSTR -> "wstr"
; lpBackupFileName : LPCWSTR optional -> "wstr"
; dwReplaceFlags : REPLACE_FILE_FLAGS -> "int"
; lpExclude : void* optional -> "sptr"
; lpReserved : void* optional -> "sptr"

; BOOL ReplaceFileW(LPCWSTR lpReplacedFileName, LPCWSTR lpReplacementFileName, LPCWSTR lpBackupFileName, REPLACE_FILE_FLAGS dwReplaceFlags, void* lpExclude, void* lpReserved)
#uselib "KERNEL32.dll"
#cfunc global ReplaceFileW "ReplaceFileW" wstr, wstr, wstr, int, intptr, intptr
; res = ReplaceFileW(lpReplacedFileName, lpReplacementFileName, lpBackupFileName, dwReplaceFlags, lpExclude, lpReserved)
; lpReplacedFileName : LPCWSTR -> "wstr"
; lpReplacementFileName : LPCWSTR -> "wstr"
; lpBackupFileName : LPCWSTR optional -> "wstr"
; 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")
	procReplaceFileW = kernel32.NewProc("ReplaceFileW")
)

// lpReplacedFileName (LPCWSTR), lpReplacementFileName (LPCWSTR), lpBackupFileName (LPCWSTR optional), dwReplaceFlags (REPLACE_FILE_FLAGS), lpExclude (void* optional), lpReserved (void* optional)
r1, _, err := procReplaceFileW.Call(
	uintptr(unsafe.Pointer(windows.StringToUTF16Ptr(lpReplacedFileName))),
	uintptr(unsafe.Pointer(windows.StringToUTF16Ptr(lpReplacementFileName))),
	uintptr(unsafe.Pointer(windows.StringToUTF16Ptr(lpBackupFileName))),
	uintptr(dwReplaceFlags),
	uintptr(lpExclude),
	uintptr(lpReserved),
)
_ = err  // syscall.Errno (valid when the call sets last-error)
_ = r1   // BOOL

function ReplaceFileW(
  lpReplacedFileName: PWideChar;   // LPCWSTR
  lpReplacementFileName: PWideChar;   // LPCWSTR
  lpBackupFileName: PWideChar;   // LPCWSTR optional
  dwReplaceFlags: DWORD;   // REPLACE_FILE_FLAGS
  lpExclude: Pointer;   // void* optional
  lpReserved: Pointer   // void* optional
): BOOL; stdcall;
  external 'KERNEL32.dll' name 'ReplaceFileW';

result := DllCall("KERNEL32\ReplaceFileW"
    , "WStr", lpReplacedFileName   ; LPCWSTR
    , "WStr", lpReplacementFileName   ; LPCWSTR
    , "WStr", lpBackupFileName   ; LPCWSTR optional
    , "UInt", dwReplaceFlags   ; REPLACE_FILE_FLAGS
    , "Ptr", lpExclude   ; void* optional
    , "Ptr", lpReserved   ; void* optional
    , "Int")   ; return: BOOL

●ReplaceFileW(lpReplacedFileName, lpReplacementFileName, lpBackupFileName, dwReplaceFlags, lpExclude, lpReserved) = DLL("KERNEL32.dll", "bool ReplaceFileW(char*, char*, char*, dword, void*, void*)")
# 呼び出し: ReplaceFileW(lpReplacedFileName, lpReplacementFileName, lpBackupFileName, dwReplaceFlags, lpExclude, lpReserved)
# lpReplacedFileName : LPCWSTR -> "char*"
# lpReplacementFileName : LPCWSTR -> "char*"
# lpBackupFileName : LPCWSTR optional -> "char*"
# dwReplaceFlags : REPLACE_FILE_FLAGS -> "dword"
# lpExclude : void* optional -> "void*"
# lpReserved : void* optional -> "void*"
# なでしこ1は32bit・ANSI(Shift_JIS)。文字列=char*(ANSI)、ポインタ/ハンドル=void*(4byte)。
# ※-W(Unicode)関数。なでしこ1はANSIのため -A 版の利用を推奨。