Win32 API 日本語リファレンス
ホームStorage.FileSystem › ReplaceFileW

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

パラメーター

名前方向説明
lpReplacedFileNameLPCWSTRin

置き換えられるファイルの名前。

既定では、名前は MAX_PATH 文字に制限されます。この制限を 32,767 ワイド文字まで拡張するには、パスの先頭に "\\?\" を付加します。詳細については、ファイル、パス、名前空間の名前付けを参照してください。

ヒント

Windows 10 バージョン 1607 以降では、"\\?\" を付加せずに MAX_PATH の制限を解除するようオプトインできます。詳細については、ファイル、パス、名前空間の名前付けの「Maximum Path Length Limitation」セクションを参照してください。

このファイルは GENERIC_READDELETESYNCHRONIZE のアクセス権で開かれます。共有モードは FILE_SHARE_READ | FILE_SHARE_WRITE | FILE_SHARE_DELETE です。

呼び出し元は、置き換えられるファイルに対する書き込みアクセス権を持っている必要があります。詳細については、 File Security and Access Rights を参照してください。

lpReplacementFileNameLPCWSTRin

lpReplacedFileName ファイルを置き換えるファイルの名前。

既定では、名前は MAX_PATH 文字に制限されます。この制限を 32,767 ワイド文字まで拡張するには、パスの先頭に "\\?\" を付加します。詳細については、ファイル、パス、名前空間の名前付けを参照してください。

ヒント

Windows 10 バージョン 1607 以降では、"\\?\" を付加せずに MAX_PATH の制限を解除するようオプトインできます。詳細については、ファイル、パス、名前空間の名前付けの「Maximum Path Length Limitation」セクションを参照してください。

この関数は、すべての属性と ACL を保持できるように、SYNCHRONIZEGENERIC_READGENERIC_WRITEDELETEWRITE_DAC のアクセス権でこのファイルを開こうとします。これが失敗した場合、関数は SYNCHRONIZEGENERIC_READDELETEWRITE_DAC のアクセス権でファイルを開こうとします。共有モードは指定されません。

lpBackupFileNameLPCWSTRinoptional

lpReplacedFileName ファイルのバックアップコピーとして機能するファイルの名前。 このパラメーターが NULL の場合、バックアップファイルは作成されません。バックアップファイルの実装の詳細については、解説のセクションを参照してください。

既定では、名前は MAX_PATH 文字に制限されます。この制限を 32,767 ワイド文字まで拡張するには、パスの先頭に "\\?\" を付加します。詳細については、ファイル、パス、名前空間の名前付けを参照してください。

ヒント

Windows 10 バージョン 1607 以降では、"\\?\" を付加せずに MAX_PATH の制限を解除するようオプトインできます。詳細については、ファイル、パス、名前空間の名前付けの「Maximum Path Length Limitation」セクションを参照してください。

dwReplaceFlagsREPLACE_FILE_FLAGSin

置き換えのオプション。このパラメーターには、次の値の 1 つ以上を指定できます。

意味
REPLACEFILE_WRITE_THROUGH
0x00000001
この値はサポートされていません。
REPLACEFILE_IGNORE_MERGE_ERRORS
0x00000002
置き換えられるファイルから置き換えるファイルへ情報(属性や ACL など)をマージする際に発生するエラーを無視します。 したがって、このフラグを指定し、かつ WRITE_DAC アクセス権を持っていない場合、 関数は成功しますが ACL は保持されません。
REPLACEFILE_IGNORE_ACL_ERRORS
0x00000004
置き換えられるファイルから置き換えるファイルへ ACL 情報をマージする際に発生するエラーを無視します。 したがって、このフラグを指定し、かつ WRITE_DAC アクセス権を持っていない場合、関数は 成功しますが ACL は保持されません。この値を使用するアプリケーションをコンパイルするには、 _WIN32_WINNT マクロを 0x0600 以降として定義します。

Windows Server 2003 および Windows XP: この値はサポートされていません。

lpExcludevoid*optional将来の使用のために予約されています。
lpReservedvoid*optional将来の使用のために予約されています。

戻り値の型: BOOL

公式ドキュメント

あるファイルを別のファイルで置き換えます。元のファイルのバックアップコピーを作成するオプションがあります。(Unicode)

戻り値

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

関数が失敗した場合、戻り値は 0 です。拡張エラー情報を取得するには、 GetLastError を呼び出します。この関数で発生し得るエラーコードは次のとおりです。

戻り値/値 説明
ERROR_UNABLE_TO_MOVE_REPLACEMENT
1176 (0x498)
置き換えるファイルの名前を変更できませんでした。lpBackupFileName が指定されている場合、 置き換えられるファイルと置き換えるファイルは元のファイル名を保持します。それ以外の場合、置き換えられるファイルは もはや存在せず、置き換えるファイルが元の名前で存在します。
ERROR_UNABLE_TO_MOVE_REPLACEMENT_2
1177 (0x499)
置き換えるファイルを移動できませんでした。置き換えるファイルは元の名前のまま存在しますが、 置き換える対象のファイルからファイルストリームと属性を継承しています。置き換えられる対象のファイルは 別の名前で存在し続けます。lpBackupFileName が指定されている場合、それが 置き換えられたファイルの名前になります。
ERROR_UNABLE_TO_REMOVE_REPLACED
1175 (0x497)
置き換えられるファイルを削除できませんでした。置き換えられるファイルと置き換えるファイルは元のファイル名を 保持します。

ERROR_INVALID_PARAMETER など、その他のエラーが返された場合、置き換えられるファイルと 置き換えるファイルは元のファイル名を保持します。このシナリオでは、バックアップファイルは 存在せず、置き換えるファイルが置き換えられるファイルのすべての属性とストリームを継承したことは 保証されません。

解説(Remarks)

Tip Windows 10 バージョン 1607 以降では、この関数の Unicode 版(ReplaceFileW)について、MAX_PATH の制限を解除するようオプトインできます。詳細については、Naming Files, Paths, and Namespaces の「Maximum Path Length Limitation」セクションを参照してください。
ReplaceFile 関数は、いくつかのステップを 1 つの関数にまとめたものです。 アプリケーションは、データを新しいファイルに保存し、元のファイルを一時的な名前に変更し、 新しいファイルを元のファイルと同じ名前に変更し、元のファイルを削除するという個別の関数を呼び出す代わりに、 ReplaceFile を呼び出すことができます。もう 1 つの利点は、 ReplaceFile が新しいファイルデータをコピーするだけでなく、 元のファイルの次の属性も保持することです。 たとえば、置き換えるファイルが暗号化されていても、置き換えられるファイルが暗号化されていない場合、 結果として得られるファイルは暗号化されません。

Windows 7、Windows Server 2008 R2、Windows Server 2008、Windows Vista、Windows Server 2003 および Windows XP: 元のファイルのセキュリティリソース属性(ATTRIBUTE_SECURITY_INFORMATION)は、 Windows 8 および Windows Server 2012 まで保持されません。

Note

置き換えるファイルが Selective Wipe を使用して保護されている場合、置き換えられるファイルは置き換えるファイルのエンタープライズ ID によって保護されます。

結果として得られるファイルは、置き換えるファイルと同じファイル ID を持ちます。

バックアップファイル、置き換えられるファイル、置き換えるファイルは、すべて同じボリューム上に存在する必要があります。

ファイルを削除または名前変更するには、そのファイルに対する削除アクセス許可、または親ディレクトリに対する子の削除アクセス許可のいずれかを 持っている必要があります。削除と子の削除を除くすべてのアクセスを持つディレクトリを設定し、 新しいファイルの DACL が継承される場合、ファイルを作成できても削除できないようにすることができます。ただし、 その場合でもファイルを作成でき、ファイルを作成した時点で返されるハンドルに対して要求したすべてのアクセスを取得します。 ファイルの作成時に削除アクセス許可を要求した場合、そのハンドルでファイルを削除または名前変更できますが、 他のハンドルではできません。

メモ

winbase.h ヘッダーは、ReplaceFile を、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)

各言語での呼び出し定義

// 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 <MarshalAs(UnmanagedType.Bool)> 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 版の利用を推奨。
const std = @import("std");

extern "kernel32" fn ReplaceFileW(
    lpReplacedFileName: [*c]const u16, // LPCWSTR
    lpReplacementFileName: [*c]const u16, // LPCWSTR
    lpBackupFileName: [*c]const u16, // LPCWSTR optional
    dwReplaceFlags: u32, // REPLACE_FILE_FLAGS
    lpExclude: ?*anyopaque, // void* optional
    lpReserved: ?*anyopaque // void* optional
) callconv(std.os.windows.WINAPI) i32;
// Unicode(-W): UTF-16LE のヌル終端バッファ([*c]const u16)を渡す。
proc ReplaceFileW(
    lpReplacedFileName: WideCString,  # LPCWSTR
    lpReplacementFileName: WideCString,  # LPCWSTR
    lpBackupFileName: WideCString,  # LPCWSTR optional
    dwReplaceFlags: uint32,  # REPLACE_FILE_FLAGS
    lpExclude: pointer,  # void* optional
    lpReserved: pointer  # void* optional
): int32 {.importc: "ReplaceFileW", stdcall, dynlib: "KERNEL32.dll".}
# Unicode(-W): WideCString は newWideCString("...") で生成。
pragma(lib, "kernel32");
extern(Windows)
int ReplaceFileW(
    const(wchar)* lpReplacedFileName,   // LPCWSTR
    const(wchar)* lpReplacementFileName,   // LPCWSTR
    const(wchar)* lpBackupFileName,   // LPCWSTR optional
    uint dwReplaceFlags,   // REPLACE_FILE_FLAGS
    void* lpExclude,   // void* optional
    void* lpReserved   // void* optional
);
ccall((:ReplaceFileW, "KERNEL32.dll"), stdcall, Int32,
      (Cwstring, Cwstring, Cwstring, UInt32, Ptr{Cvoid}, Ptr{Cvoid}),
      lpReplacedFileName, lpReplacementFileName, lpBackupFileName, dwReplaceFlags, lpExclude, lpReserved)
# lpReplacedFileName : LPCWSTR -> Cwstring
# lpReplacementFileName : LPCWSTR -> Cwstring
# lpBackupFileName : LPCWSTR optional -> Cwstring
# dwReplaceFlags : REPLACE_FILE_FLAGS -> UInt32
# lpExclude : void* optional -> Ptr{Cvoid}
# lpReserved : void* optional -> Ptr{Cvoid}
# stdcall は 32bit のみ意味を持つ(x64 では無視)。
# Unicode(-W): Cwstring には transcode(UInt16, "...") 等で UTF-16 を渡す。
local ffi = require("ffi")
ffi.cdef[[
int32_t ReplaceFileW(
    const uint16_t* lpReplacedFileName,
    const uint16_t* lpReplacementFileName,
    const uint16_t* lpBackupFileName,
    uint32_t dwReplaceFlags,
    void* lpExclude,
    void* lpReserved);
]]
local kernel32 = ffi.load("kernel32")
-- kernel32.ReplaceFileW(lpReplacedFileName, lpReplacementFileName, lpBackupFileName, dwReplaceFlags, lpExclude, lpReserved)
-- lpReplacedFileName : LPCWSTR
-- lpReplacementFileName : LPCWSTR
-- lpBackupFileName : LPCWSTR optional
-- dwReplaceFlags : REPLACE_FILE_FLAGS
-- lpExclude : void* optional
-- lpReserved : void* optional
-- 構造体/GUIDへのポインタは cdef が通るよう void* で表記(実型は各引数コメント参照)。値渡し構造体・enum は対応する typedef を cdef に追加すること。
-- Unicode(-W): uint16_t* には UTF-16LE のバッファ(ffi.new("uint16_t[?]", ...))を渡す。
const koffi = require('koffi');
const lib = koffi.load('KERNEL32.dll');
const ReplaceFileW = lib.func('__stdcall', 'ReplaceFileW', 'int32_t', ['str16', 'str16', 'str16', 'uint32_t', 'void *', 'void *']);
// ReplaceFileW(lpReplacedFileName, lpReplacementFileName, lpBackupFileName, dwReplaceFlags, lpExclude, lpReserved)
// lpReplacedFileName : LPCWSTR -> 'str16'
// lpReplacementFileName : LPCWSTR -> 'str16'
// lpBackupFileName : LPCWSTR optional -> 'str16'
// dwReplaceFlags : REPLACE_FILE_FLAGS -> 'uint32_t'
// lpExclude : void* optional -> 'void *'
// lpReserved : void* optional -> 'void *'
// 出力ポインタは koffi.out(...) で包む。構造体は koffi.struct で定義。
const lib = Deno.dlopen("KERNEL32.dll", {
  ReplaceFileW: { parameters: ["buffer", "buffer", "buffer", "u32", "pointer", "pointer"], result: "i32" },
});
// lib.symbols.ReplaceFileW(lpReplacedFileName, lpReplacementFileName, lpBackupFileName, dwReplaceFlags, lpExclude, lpReserved)
// lpReplacedFileName : LPCWSTR -> "buffer"
// lpReplacementFileName : LPCWSTR -> "buffer"
// lpBackupFileName : LPCWSTR optional -> "buffer"
// dwReplaceFlags : REPLACE_FILE_FLAGS -> "u32"
// lpExclude : void* optional -> "pointer"
// lpReserved : void* optional -> "pointer"
// 文字列は "buffer"。Unicode(-W) は new TextEncoder() ではなく UTF-16LE のバイト列(末尾に \x00\x00)を Uint8Array で渡す。
// 値渡し構造体は { struct: [ ...field types... ] } を使用。
<?php
$ffi = FFI::cdef(<<<C
int32_t ReplaceFileW(
    const uint16_t* lpReplacedFileName,
    const uint16_t* lpReplacementFileName,
    const uint16_t* lpBackupFileName,
    uint32_t dwReplaceFlags,
    void* lpExclude,
    void* lpReserved);
C, "KERNEL32.dll");
// $ffi->ReplaceFileW(lpReplacedFileName, lpReplacementFileName, lpBackupFileName, dwReplaceFlags, lpExclude, lpReserved);
// lpReplacedFileName : LPCWSTR
// lpReplacementFileName : LPCWSTR
// lpBackupFileName : LPCWSTR 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.UNICODE_OPTIONS);
    boolean ReplaceFileW(
        WString lpReplacedFileName,   // LPCWSTR
        WString lpReplacementFileName,   // LPCWSTR
        WString lpBackupFileName,   // LPCWSTR optional
        int dwReplaceFlags,   // REPLACE_FILE_FLAGS
        Pointer lpExclude,   // void* optional
        Pointer lpReserved   // void* optional
    );
}
// Unicode(-W): WString(入力)/char[](出力)で UTF-16 をマーシャリング。
@[Link("kernel32")]
lib LibKERNEL32
  fun ReplaceFileW = ReplaceFileW(
    lpReplacedFileName : UInt16*,   # LPCWSTR
    lpReplacementFileName : UInt16*,   # LPCWSTR
    lpBackupFileName : UInt16*,   # LPCWSTR 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 ReplaceFileWNative = Int32 Function(Pointer<Utf16>, Pointer<Utf16>, Pointer<Utf16>, Uint32, Pointer<Void>, Pointer<Void>);
typedef ReplaceFileWDart = int Function(Pointer<Utf16>, Pointer<Utf16>, Pointer<Utf16>, int, Pointer<Void>, Pointer<Void>);
final ReplaceFileW = DynamicLibrary.open('KERNEL32.dll')
    .lookupFunction<ReplaceFileWNative, ReplaceFileWDart>('ReplaceFileW');
// lpReplacedFileName : LPCWSTR -> Pointer<Utf16>
// lpReplacementFileName : LPCWSTR -> Pointer<Utf16>
// lpBackupFileName : LPCWSTR optional -> Pointer<Utf16>
// dwReplaceFlags : REPLACE_FILE_FLAGS -> Uint32
// lpExclude : void* optional -> Pointer<Void>
// lpReserved : void* optional -> Pointer<Void>
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。
{$mode objfpc}{$H+}
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';
import Foreign
import Foreign.C.Types
import Foreign.C.String

foreign import stdcall safe "ReplaceFileW"
  c_ReplaceFileW :: CWString -> CWString -> CWString -> Word32 -> Ptr () -> Ptr () -> IO CInt
-- lpReplacedFileName : LPCWSTR -> CWString
-- lpReplacementFileName : LPCWSTR -> CWString
-- lpBackupFileName : LPCWSTR optional -> CWString
-- 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 replacefilew =
  foreign "ReplaceFileW"
    ((ptr uint16_t) @-> (ptr uint16_t) @-> (ptr uint16_t) @-> uint32_t @-> (ptr void) @-> (ptr void) @-> returning int32_t)
(* lpReplacedFileName : LPCWSTR -> (ptr uint16_t) *)
(* lpReplacementFileName : LPCWSTR -> (ptr uint16_t) *)
(* lpBackupFileName : LPCWSTR optional -> (ptr uint16_t) *)
(* 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 ("ReplaceFileW" replace-file-w :convention :stdcall) :int32
  (lp-replaced-file-name (:string :encoding :utf-16le))   ; LPCWSTR
  (lp-replacement-file-name (:string :encoding :utf-16le))   ; LPCWSTR
  (lp-backup-file-name (:string :encoding :utf-16le))   ; LPCWSTR 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 $ReplaceFileW = Win32::API::More->new('KERNEL32',
    'BOOL ReplaceFileW(LPCWSTR lpReplacedFileName, LPCWSTR lpReplacementFileName, LPCWSTR lpBackupFileName, DWORD dwReplaceFlags, LPVOID lpExclude, LPVOID lpReserved)');
# my $ret = $ReplaceFileW->Call($lpReplacedFileName, $lpReplacementFileName, $lpBackupFileName, $dwReplaceFlags, $lpExclude, $lpReserved);
# lpReplacedFileName : LPCWSTR -> LPCWSTR
# lpReplacementFileName : LPCWSTR -> LPCWSTR
# lpBackupFileName : LPCWSTR optional -> LPCWSTR
# dwReplaceFlags : REPLACE_FILE_FLAGS -> DWORD
# lpExclude : void* optional -> LPVOID
# lpReserved : void* optional -> LPVOID
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。
# Unicode(-W): LPCWSTR/LPWSTR は Win32::API が UTF-16 変換を行う。

関連項目

文字セット違い
公式の関連項目
使用する型