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

CopyFileExW

関数
進捗通知付きでファイルをコピーする(Unicode版)。
DLLKERNEL32.dll文字セットUnicode (-W)呼出規約winapiSetLastErrorあり対応OSWindows XP 以降

シグネチャ

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

BOOL CopyFileExW(
    LPCWSTR lpExistingFileName,
    LPCWSTR lpNewFileName,
    LPPROGRESS_ROUTINE lpProgressRoutine,   // optional
    void* lpData,   // optional
    BOOL* pbCancel,   // optional
    COPYFILE_FLAGS dwCopyFlags
);

パラメーター

名前方向説明
lpExistingFileNameLPCWSTRin

既存のファイルの名前。

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

ヒント

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

lpExistingFileName が存在しない場合、 CopyFileEx 関数は失敗し、 GetLastError 関数は ERROR_FILE_NOT_FOUND を返します。

lpNewFileNameLPCWSTRin

新しいファイルの名前。

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

ヒント

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

lpProgressRoutineLPPROGRESS_ROUTINEinoptionalファイルの別の部分がコピーされるたびに呼び出される、LPPROGRESS_ROUTINE 型のコールバック関数のアドレス。このパラメーターは NULL にできます。進行状況コールバック関数の詳細については、 CopyProgressRoutine 関数を参照してください。
lpDatavoid*inoptionalコールバック関数に渡される引数。このパラメーターは NULL にできます。
pbCancelBOOL*inoutoptionalコピー操作中にこのフラグが TRUE に設定されると、操作はキャンセルされます。 それ以外の場合、コピー操作は完了まで続行されます。
dwCopyFlagsCOPYFILE_FLAGSin

ファイルのコピー方法を指定するフラグ。このパラメーターには、次の 値の組み合わせを指定できます。

意味
COPY_FILE_ALLOW_DECRYPTED_DESTINATION
0x00000008
暗号化されたファイルのコピーは、コピー先を暗号化できない場合でも成功します。
COPY_FILE_COPY_SYMLINK
0x00000800
コピー元ファイルがシンボリックリンクである場合、コピー先ファイルも、コピー元のシンボリックリンクが指しているのと同じファイルを指すシンボリックリンクになります。

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

COPY_FILE_FAIL_IF_EXISTS
0x00000001
コピー先ファイルが既に存在する場合、コピー操作は直ちに失敗します。
COPY_FILE_NO_BUFFERING
0x00001000
コピー操作は、システム I/O キャッシュリソースをバイパスして、バッファーなし I/O を使用して実行されます。非常に大きなファイル転送に推奨されます。

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

COPY_FILE_OPEN_SOURCE_FOR_WRITE
0x00000004
ファイルがコピーされ、元のファイルが書き込みアクセス用に開かれます。
COPY_FILE_RESTARTABLE
0x00000002
コピーが失敗した場合に備えて、コピーの進行状況がコピー先ファイルに記録されます。失敗したコピーは、失敗した呼び出しで使用したのと同じ値を lpExistingFileName および lpNewFileName に指定することで、後で再開できます。コピー操作中に新しいファイルが複数回フラッシュされる可能性があるため、コピー操作が大幅に遅くなることがあります。
COPY_FILE_REQUEST_COMPRESSED_TRAFFIC
0x10000000

コピー操作中に、基盤となる転送チャネルがデータを圧縮するよう要求します。この要求はすべてのメディアでサポートされるわけではなく、サポートされない場合は無視されます。圧縮属性とパラメーター(計算の複雑さ、メモリ使用量)は、この API を通じて構成することはできず、OS リリースによって変更される可能性があります。

このフラグは Windows 10 バージョン 1903 および Windows Server 2022 で導入されました。Windows 10 では、このフラグは、ネゴシエートされた SMB プロトコルバージョンが SMB v3.1.1 以上である SMB 共有上に存在するファイルでサポートされます。

戻り値の型: BOOL

公式ドキュメント

既存のファイルを新しいファイルにコピーし、コールバック関数を通じて進行状況をアプリケーションに通知します。(CopyFileExW)

戻り値

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

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

ユーザーが操作をキャンセルしたために lpProgressRoutinePROGRESS_CANCEL を返した場合、CopyFileEx は 0 を返し、 GetLastErrorERROR_REQUEST_ABORTED を返します。この場合、部分的にコピーされたコピー先ファイルは削除されます。

ユーザーが操作を停止したために lpProgressRoutinePROGRESS_STOP を返した場合、CopyFileEx は 0 を返し、 GetLastErrorERROR_REQUEST_ABORTED を返します。この場合、部分的にコピーされたコピー先ファイルはそのまま残されます。

解説(Remarks)

この関数は、拡張属性、OLE 構造化ストレージ、NTFS ファイルシステムの代替データストリーム、 セキュリティリソース属性、およびファイル属性を保持します。

Windows 7、Windows Server 2008 R2、Windows Server 2008、Windows Vista、Windows Server 2003 および Windows XP: 既存のファイルのセキュリティリソース属性 (ATTRIBUTE_SECURITY_INFORMATION) は、Windows 8 および Windows Server 2012 になるまで新しいファイルにコピーされません。

既存のファイルのセキュリティリソースプロパティ (ATTRIBUTE_SECURITY_INFORMATION) は、 新しいファイルにコピーされます。

Windows 7、Windows Server 2008 R2、Windows Server 2008、Windows Vista、Windows Server 2003 および Windows XP: 既存のファイルのセキュリティリソースプロパティは、 Windows 8 および Windows Server 2012 になるまで新しいファイルにコピーされません。

コピー先ファイルが既に存在し、FILE_ATTRIBUTE_HIDDEN または FILE_ATTRIBUTE_READONLY 属性が設定されている場合、この関数は ERROR_ACCESS_DENIED で失敗します。

暗号化されたファイルが CopyFileEx を使用してコピーされる場合、この 関数は、コピー元ファイルの暗号化に使用されたキーでコピー先ファイルを暗号化しようとします。これが できない場合、この関数は既定のキーでコピー先ファイルを暗号化しようとします。これら両方の 方法ができない場合、CopyFileExERROR_ENCRYPTION_FAILED エラーコードで失敗します。コピー先ファイルを暗号化できない場合でも CopyFileEx にコピー操作を完了させたい場合は、 CopyFileEx の呼び出しで dwCopyFlags パラメーターの値として COPY_FILE_ALLOW_DECRYPTED_DESTINATION を含めます。

COPY_FILE_COPY_SYMLINK が指定されている場合、次の規則が適用されます。

COPY_FILE_COPY_SYMLINK が指定されていない場合、次の規則が適用されます。

Windows 7、Windows Server 2008 R2、Windows Server 2008、Windows Vista、Windows Server 2003 および Windows XP: LAN 全体でのファイルコピー操作を最適化するアプリケーションを作成する場合は、Windows ソケット (Winsock) の TransmitFile 関数の使用を検討してください。TransmitFile は高パフォーマンスの ネットワーク転送をサポートし、ファイルの内容をリモートコンピューターに送信するためのシンプルなインターフェイスを提供します。 TransmitFile を使用するには、コピー元コンピューターからファイルを送信する Winsock クライアント アプリケーションと、他の Winsock 関数を使用してリモートコンピューターでファイルを受信する Winsock サーバー アプリケーションを作成する必要があります。

Windows 8 および Windows Server 2012 では、この関数は次のテクノロジによってサポートされています。

テクノロジ サポート
Server Message Block (SMB) 3.0 プロトコル はい
SMB 3.0 透過的フェールオーバー (TFO) はい
スケールアウトファイル共有を備えた SMB 3.0 (SO) はい
クラスター共有ボリュームファイルシステム (CsvFS) はい
回復性のあるファイルシステム (ReFS) はい
メモ

winbase.h ヘッダーは CopyFileEx を、UNICODE プリプロセッサ定数の定義に基づいてこの関数の ANSI 版または Unicode 版を自動的に選択するエイリアスとして定義します。エンコーディング中立のエイリアスの使用を、エンコーディング中立でないコードと混在させると、コンパイルエラーまたは実行時エラーを引き起こす不一致につながる可能性があります。詳細については、関数プロトタイプの規則 を参照してください。

出典・ライセンス: 上記「公式ドキュメント」の内容は 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 CopyFileExW(
    LPCWSTR lpExistingFileName,
    LPCWSTR lpNewFileName,
    LPPROGRESS_ROUTINE lpProgressRoutine,   // optional
    void* lpData,   // optional
    BOOL* pbCancel,   // optional
    COPYFILE_FLAGS dwCopyFlags
);
[return: MarshalAs(UnmanagedType.Bool)]
[DllImport("KERNEL32.dll", CharSet = CharSet.Unicode, SetLastError = true, ExactSpelling = true)]
static extern bool CopyFileExW(
    [MarshalAs(UnmanagedType.LPWStr)] string lpExistingFileName,   // LPCWSTR
    [MarshalAs(UnmanagedType.LPWStr)] string lpNewFileName,   // LPCWSTR
    IntPtr lpProgressRoutine,   // LPPROGRESS_ROUTINE optional
    IntPtr lpData,   // void* optional
    IntPtr pbCancel,   // BOOL* optional, in/out
    uint dwCopyFlags   // COPYFILE_FLAGS
);
<DllImport("KERNEL32.dll", CharSet:=CharSet.Unicode, SetLastError:=True, ExactSpelling:=True)>
Public Shared Function CopyFileExW(
    <MarshalAs(UnmanagedType.LPWStr)> lpExistingFileName As String,   ' LPCWSTR
    <MarshalAs(UnmanagedType.LPWStr)> lpNewFileName As String,   ' LPCWSTR
    lpProgressRoutine As IntPtr,   ' LPPROGRESS_ROUTINE optional
    lpData As IntPtr,   ' void* optional
    pbCancel As IntPtr,   ' BOOL* optional, in/out
    dwCopyFlags As UInteger   ' COPYFILE_FLAGS
) As <MarshalAs(UnmanagedType.Bool)> Boolean
End Function
' lpExistingFileName : LPCWSTR
' lpNewFileName : LPCWSTR
' lpProgressRoutine : LPPROGRESS_ROUTINE optional
' lpData : void* optional
' pbCancel : BOOL* optional, in/out
' dwCopyFlags : COPYFILE_FLAGS
Declare PtrSafe Function CopyFileExW Lib "kernel32" ( _
    ByVal lpExistingFileName As LongPtr, _
    ByVal lpNewFileName As LongPtr, _
    ByVal lpProgressRoutine As LongPtr, _
    ByVal lpData As LongPtr, _
    ByVal pbCancel As LongPtr, _
    ByVal dwCopyFlags As Long) 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

CopyFileExW = ctypes.windll.kernel32.CopyFileExW
CopyFileExW.restype = wintypes.BOOL
CopyFileExW.argtypes = [
    wintypes.LPCWSTR,  # lpExistingFileName : LPCWSTR
    wintypes.LPCWSTR,  # lpNewFileName : LPCWSTR
    ctypes.c_void_p,  # lpProgressRoutine : LPPROGRESS_ROUTINE optional
    ctypes.POINTER(None),  # lpData : void* optional
    ctypes.c_void_p,  # pbCancel : BOOL* optional, in/out
    wintypes.DWORD,  # dwCopyFlags : COPYFILE_FLAGS
]
# GetLastError: use ctypes.GetLastError() (or ctypes.WinDLL(use_last_error=True))
require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('KERNEL32.dll')
CopyFileExW = Fiddle::Function.new(
  lib['CopyFileExW'],
  [
    Fiddle::TYPE_VOIDP,  # lpExistingFileName : LPCWSTR
    Fiddle::TYPE_VOIDP,  # lpNewFileName : LPCWSTR
    Fiddle::TYPE_VOIDP,  # lpProgressRoutine : LPPROGRESS_ROUTINE optional
    Fiddle::TYPE_VOIDP,  # lpData : void* optional
    Fiddle::TYPE_VOIDP,  # pbCancel : BOOL* optional, in/out
    -Fiddle::TYPE_INT,  # dwCopyFlags : COPYFILE_FLAGS
  ],
  Fiddle::TYPE_INT)
# Wide strings: pass str.encode("UTF-16LE") + "\x00\x00"
#[link(name = "kernel32")]
extern "system" {
    fn CopyFileExW(
        lpExistingFileName: *const u16,  // LPCWSTR
        lpNewFileName: *const u16,  // LPCWSTR
        lpProgressRoutine: *const core::ffi::c_void,  // LPPROGRESS_ROUTINE optional
        lpData: *mut (),  // void* optional
        pbCancel: *mut i32,  // BOOL* optional, in/out
        dwCopyFlags: u32  // COPYFILE_FLAGS
    ) -> 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 CopyFileExW([MarshalAs(UnmanagedType.LPWStr)] string lpExistingFileName, [MarshalAs(UnmanagedType.LPWStr)] string lpNewFileName, IntPtr lpProgressRoutine, IntPtr lpData, IntPtr pbCancel, uint dwCopyFlags);
"@
$api = Add-Type -MemberDefinition $sig -Name 'KERNEL32_CopyFileExW' -Namespace Win32 -PassThru
# $api::CopyFileExW(lpExistingFileName, lpNewFileName, lpProgressRoutine, lpData, pbCancel, dwCopyFlags)
#uselib "KERNEL32.dll"
#func global CopyFileExW "CopyFileExW" wptr, wptr, wptr, wptr, wptr, wptr
; CopyFileExW lpExistingFileName, lpNewFileName, lpProgressRoutine, lpData, varptr(pbCancel), dwCopyFlags   ; 戻り値は stat
; lpExistingFileName : LPCWSTR -> "wptr"
; lpNewFileName : LPCWSTR -> "wptr"
; lpProgressRoutine : LPPROGRESS_ROUTINE optional -> "wptr"
; lpData : void* optional -> "wptr"
; pbCancel : BOOL* optional, in/out -> "wptr"
; dwCopyFlags : COPYFILE_FLAGS -> "wptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。
出力引数:
#uselib "KERNEL32.dll"
#cfunc global CopyFileExW "CopyFileExW" wstr, wstr, sptr, sptr, var, int
; res = CopyFileExW(lpExistingFileName, lpNewFileName, lpProgressRoutine, lpData, pbCancel, dwCopyFlags)
; lpExistingFileName : LPCWSTR -> "wstr"
; lpNewFileName : LPCWSTR -> "wstr"
; lpProgressRoutine : LPPROGRESS_ROUTINE optional -> "sptr"
; lpData : void* optional -> "sptr"
; pbCancel : BOOL* optional, in/out -> "var"
; dwCopyFlags : COPYFILE_FLAGS -> "int"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。
出力引数:
; BOOL CopyFileExW(LPCWSTR lpExistingFileName, LPCWSTR lpNewFileName, LPPROGRESS_ROUTINE lpProgressRoutine, void* lpData, BOOL* pbCancel, COPYFILE_FLAGS dwCopyFlags)
#uselib "KERNEL32.dll"
#cfunc global CopyFileExW "CopyFileExW" wstr, wstr, intptr, intptr, var, int
; res = CopyFileExW(lpExistingFileName, lpNewFileName, lpProgressRoutine, lpData, pbCancel, dwCopyFlags)
; lpExistingFileName : LPCWSTR -> "wstr"
; lpNewFileName : LPCWSTR -> "wstr"
; lpProgressRoutine : LPPROGRESS_ROUTINE optional -> "intptr"
; lpData : void* optional -> "intptr"
; pbCancel : BOOL* optional, in/out -> "var"
; dwCopyFlags : COPYFILE_FLAGS -> "int"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。
import (
	"golang.org/x/sys/windows"
	"unsafe"
)

var (
	kernel32 = windows.NewLazySystemDLL("KERNEL32.dll")
	procCopyFileExW = kernel32.NewProc("CopyFileExW")
)

// lpExistingFileName (LPCWSTR), lpNewFileName (LPCWSTR), lpProgressRoutine (LPPROGRESS_ROUTINE optional), lpData (void* optional), pbCancel (BOOL* optional, in/out), dwCopyFlags (COPYFILE_FLAGS)
r1, _, err := procCopyFileExW.Call(
	uintptr(unsafe.Pointer(windows.StringToUTF16Ptr(lpExistingFileName))),
	uintptr(unsafe.Pointer(windows.StringToUTF16Ptr(lpNewFileName))),
	uintptr(lpProgressRoutine),
	uintptr(lpData),
	uintptr(pbCancel),
	uintptr(dwCopyFlags),
)
_ = err  // syscall.Errno (valid when the call sets last-error)
_ = r1   // BOOL
function CopyFileExW(
  lpExistingFileName: PWideChar;   // LPCWSTR
  lpNewFileName: PWideChar;   // LPCWSTR
  lpProgressRoutine: Pointer;   // LPPROGRESS_ROUTINE optional
  lpData: Pointer;   // void* optional
  pbCancel: Pointer;   // BOOL* optional, in/out
  dwCopyFlags: DWORD   // COPYFILE_FLAGS
): BOOL; stdcall;
  external 'KERNEL32.dll' name 'CopyFileExW';
result := DllCall("KERNEL32\CopyFileExW"
    , "WStr", lpExistingFileName   ; LPCWSTR
    , "WStr", lpNewFileName   ; LPCWSTR
    , "Ptr", lpProgressRoutine   ; LPPROGRESS_ROUTINE optional
    , "Ptr", lpData   ; void* optional
    , "Ptr", pbCancel   ; BOOL* optional, in/out
    , "UInt", dwCopyFlags   ; COPYFILE_FLAGS
    , "Int")   ; return: BOOL
●CopyFileExW(lpExistingFileName, lpNewFileName, lpProgressRoutine, lpData, pbCancel, dwCopyFlags) = DLL("KERNEL32.dll", "bool CopyFileExW(char*, char*, void*, void*, void*, dword)")
# 呼び出し: CopyFileExW(lpExistingFileName, lpNewFileName, lpProgressRoutine, lpData, pbCancel, dwCopyFlags)
# lpExistingFileName : LPCWSTR -> "char*"
# lpNewFileName : LPCWSTR -> "char*"
# lpProgressRoutine : LPPROGRESS_ROUTINE optional -> "void*"
# lpData : void* optional -> "void*"
# pbCancel : BOOL* optional, in/out -> "void*"
# dwCopyFlags : COPYFILE_FLAGS -> "dword"
# なでしこ1は32bit・ANSI(Shift_JIS)。文字列=char*(ANSI)、ポインタ/ハンドル=void*(4byte)。
# ※-W(Unicode)関数。なでしこ1はANSIのため -A 版の利用を推奨。
const std = @import("std");

extern "kernel32" fn CopyFileExW(
    lpExistingFileName: [*c]const u16, // LPCWSTR
    lpNewFileName: [*c]const u16, // LPCWSTR
    lpProgressRoutine: ?*anyopaque, // LPPROGRESS_ROUTINE optional
    lpData: ?*anyopaque, // void* optional
    pbCancel: [*c]i32, // BOOL* optional, in/out
    dwCopyFlags: u32 // COPYFILE_FLAGS
) callconv(std.os.windows.WINAPI) i32;
// Unicode(-W): UTF-16LE のヌル終端バッファ([*c]const u16)を渡す。
proc CopyFileExW(
    lpExistingFileName: WideCString,  # LPCWSTR
    lpNewFileName: WideCString,  # LPCWSTR
    lpProgressRoutine: pointer,  # LPPROGRESS_ROUTINE optional
    lpData: pointer,  # void* optional
    pbCancel: ptr int32,  # BOOL* optional, in/out
    dwCopyFlags: uint32  # COPYFILE_FLAGS
): int32 {.importc: "CopyFileExW", stdcall, dynlib: "KERNEL32.dll".}
# Unicode(-W): WideCString は newWideCString("...") で生成。
pragma(lib, "kernel32");
extern(Windows)
int CopyFileExW(
    const(wchar)* lpExistingFileName,   // LPCWSTR
    const(wchar)* lpNewFileName,   // LPCWSTR
    void* lpProgressRoutine,   // LPPROGRESS_ROUTINE optional
    void* lpData,   // void* optional
    int* pbCancel,   // BOOL* optional, in/out
    uint dwCopyFlags   // COPYFILE_FLAGS
);
ccall((:CopyFileExW, "KERNEL32.dll"), stdcall, Int32,
      (Cwstring, Cwstring, Ptr{Cvoid}, Ptr{Cvoid}, Ptr{Int32}, UInt32),
      lpExistingFileName, lpNewFileName, lpProgressRoutine, lpData, pbCancel, dwCopyFlags)
# lpExistingFileName : LPCWSTR -> Cwstring
# lpNewFileName : LPCWSTR -> Cwstring
# lpProgressRoutine : LPPROGRESS_ROUTINE optional -> Ptr{Cvoid}
# lpData : void* optional -> Ptr{Cvoid}
# pbCancel : BOOL* optional, in/out -> Ptr{Int32}
# dwCopyFlags : COPYFILE_FLAGS -> UInt32
# stdcall は 32bit のみ意味を持つ(x64 では無視)。
# Unicode(-W): Cwstring には transcode(UInt16, "...") 等で UTF-16 を渡す。
local ffi = require("ffi")
ffi.cdef[[
int32_t CopyFileExW(
    const uint16_t* lpExistingFileName,
    const uint16_t* lpNewFileName,
    void* lpProgressRoutine,
    void* lpData,
    int32_t* pbCancel,
    uint32_t dwCopyFlags);
]]
local kernel32 = ffi.load("kernel32")
-- kernel32.CopyFileExW(lpExistingFileName, lpNewFileName, lpProgressRoutine, lpData, pbCancel, dwCopyFlags)
-- lpExistingFileName : LPCWSTR
-- lpNewFileName : LPCWSTR
-- lpProgressRoutine : LPPROGRESS_ROUTINE optional
-- lpData : void* optional
-- pbCancel : BOOL* optional, in/out
-- dwCopyFlags : COPYFILE_FLAGS
-- 構造体/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 CopyFileExW = lib.func('__stdcall', 'CopyFileExW', 'int32_t', ['str16', 'str16', 'void *', 'void *', 'int32_t *', 'uint32_t']);
// CopyFileExW(lpExistingFileName, lpNewFileName, lpProgressRoutine, lpData, pbCancel, dwCopyFlags)
// lpExistingFileName : LPCWSTR -> 'str16'
// lpNewFileName : LPCWSTR -> 'str16'
// lpProgressRoutine : LPPROGRESS_ROUTINE optional -> 'void *'
// lpData : void* optional -> 'void *'
// pbCancel : BOOL* optional, in/out -> 'int32_t *'
// dwCopyFlags : COPYFILE_FLAGS -> 'uint32_t'
// 出力ポインタは koffi.out(...) で包む。構造体は koffi.struct で定義。
// コールバック(関数ポインタ)は koffi.proto/koffi.register で型を定義して渡す(素の void* では JS 関数を渡せない)。
const lib = Deno.dlopen("KERNEL32.dll", {
  CopyFileExW: { parameters: ["buffer", "buffer", "pointer", "pointer", "pointer", "u32"], result: "i32" },
});
// lib.symbols.CopyFileExW(lpExistingFileName, lpNewFileName, lpProgressRoutine, lpData, pbCancel, dwCopyFlags)
// lpExistingFileName : LPCWSTR -> "buffer"
// lpNewFileName : LPCWSTR -> "buffer"
// lpProgressRoutine : LPPROGRESS_ROUTINE optional -> "pointer"
// lpData : void* optional -> "pointer"
// pbCancel : BOOL* optional, in/out -> "pointer"
// dwCopyFlags : COPYFILE_FLAGS -> "u32"
// 文字列は "buffer"。Unicode(-W) は new TextEncoder() ではなく UTF-16LE のバイト列(末尾に \x00\x00)を Uint8Array で渡す。
// 値渡し構造体は { struct: [ ...field types... ] } を使用。
<?php
$ffi = FFI::cdef(<<<C
int32_t CopyFileExW(
    const uint16_t* lpExistingFileName,
    const uint16_t* lpNewFileName,
    void* lpProgressRoutine,
    void* lpData,
    int32_t* pbCancel,
    uint32_t dwCopyFlags);
C, "KERNEL32.dll");
// $ffi->CopyFileExW(lpExistingFileName, lpNewFileName, lpProgressRoutine, lpData, pbCancel, dwCopyFlags);
// lpExistingFileName : LPCWSTR
// lpNewFileName : LPCWSTR
// lpProgressRoutine : LPPROGRESS_ROUTINE optional
// lpData : void* optional
// pbCancel : BOOL* optional, in/out
// dwCopyFlags : COPYFILE_FLAGS
// 構造体/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 CopyFileExW(
        WString lpExistingFileName,   // LPCWSTR
        WString lpNewFileName,   // LPCWSTR
        Callback lpProgressRoutine,   // LPPROGRESS_ROUTINE optional
        Pointer lpData,   // void* optional
        IntByReference pbCancel,   // BOOL* optional, in/out
        int dwCopyFlags   // COPYFILE_FLAGS
    );
}
// Unicode(-W): WString(入力)/char[](出力)で UTF-16 をマーシャリング。
@[Link("kernel32")]
lib LibKERNEL32
  fun CopyFileExW = CopyFileExW(
    lpExistingFileName : UInt16*,   # LPCWSTR
    lpNewFileName : UInt16*,   # LPCWSTR
    lpProgressRoutine : Void*,   # LPPROGRESS_ROUTINE optional
    lpData : Void*,   # void* optional
    pbCancel : Int32*,   # BOOL* optional, in/out
    dwCopyFlags : UInt32   # COPYFILE_FLAGS
  ) : Int32
end
# 構造体/GUID/enum は lib 内に対応する型定義が必要。
# 呼出規約: x64 は規約統一のため OK。x86(32bit)は WINAPI=stdcall だが Crystal の fun に stdcall 付与構文がなく非対応。
import 'dart:ffi';
import 'package:ffi/ffi.dart';

typedef CopyFileExWNative = Int32 Function(Pointer<Utf16>, Pointer<Utf16>, Pointer<Void>, Pointer<Void>, Pointer<Int32>, Uint32);
typedef CopyFileExWDart = int Function(Pointer<Utf16>, Pointer<Utf16>, Pointer<Void>, Pointer<Void>, Pointer<Int32>, int);
final CopyFileExW = DynamicLibrary.open('KERNEL32.dll')
    .lookupFunction<CopyFileExWNative, CopyFileExWDart>('CopyFileExW');
// lpExistingFileName : LPCWSTR -> Pointer<Utf16>
// lpNewFileName : LPCWSTR -> Pointer<Utf16>
// lpProgressRoutine : LPPROGRESS_ROUTINE optional -> Pointer<Void>
// lpData : void* optional -> Pointer<Void>
// pbCancel : BOOL* optional, in/out -> Pointer<Int32>
// dwCopyFlags : COPYFILE_FLAGS -> Uint32
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。
{$mode objfpc}{$H+}
function CopyFileExW(
  lpExistingFileName: PWideChar;   // LPCWSTR
  lpNewFileName: PWideChar;   // LPCWSTR
  lpProgressRoutine: Pointer;   // LPPROGRESS_ROUTINE optional
  lpData: Pointer;   // void* optional
  pbCancel: Pointer;   // BOOL* optional, in/out
  dwCopyFlags: DWORD   // COPYFILE_FLAGS
): BOOL; stdcall;
  external 'KERNEL32.dll' name 'CopyFileExW';
import Foreign
import Foreign.C.Types
import Foreign.C.String

foreign import stdcall safe "CopyFileExW"
  c_CopyFileExW :: CWString -> CWString -> Ptr () -> Ptr () -> Ptr CInt -> Word32 -> IO CInt
-- lpExistingFileName : LPCWSTR -> CWString
-- lpNewFileName : LPCWSTR -> CWString
-- lpProgressRoutine : LPPROGRESS_ROUTINE optional -> Ptr ()
-- lpData : void* optional -> Ptr ()
-- pbCancel : BOOL* optional, in/out -> Ptr CInt
-- dwCopyFlags : COPYFILE_FLAGS -> Word32
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。
open Ctypes
open Foreign

let copyfileexw =
  foreign "CopyFileExW"
    ((ptr uint16_t) @-> (ptr uint16_t) @-> (ptr void) @-> (ptr void) @-> (ptr int32_t) @-> uint32_t @-> returning int32_t)
(* lpExistingFileName : LPCWSTR -> (ptr uint16_t) *)
(* lpNewFileName : LPCWSTR -> (ptr uint16_t) *)
(* lpProgressRoutine : LPPROGRESS_ROUTINE optional -> (ptr void) *)
(* lpData : void* optional -> (ptr void) *)
(* pbCancel : BOOL* optional, in/out -> (ptr int32_t) *)
(* dwCopyFlags : COPYFILE_FLAGS -> uint32_t *)
(* foreign は cdecl 前提。x64 Windows では WINAPI と一致。構造体は ctypes structure を定義のこと。 *)
(cffi:define-foreign-library kernel32 (t "KERNEL32.dll"))
(cffi:use-foreign-library kernel32)

(cffi:defcfun ("CopyFileExW" copy-file-ex-w :convention :stdcall) :int32
  (lp-existing-file-name (:string :encoding :utf-16le))   ; LPCWSTR
  (lp-new-file-name (:string :encoding :utf-16le))   ; LPCWSTR
  (lp-progress-routine :pointer)   ; LPPROGRESS_ROUTINE optional
  (lp-data :pointer)   ; void* optional
  (pb-cancel :pointer)   ; BOOL* optional, in/out
  (dw-copy-flags :uint32))   ; COPYFILE_FLAGS
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。
use Win32::API;
my $CopyFileExW = Win32::API::More->new('KERNEL32',
    'BOOL CopyFileExW(LPCWSTR lpExistingFileName, LPCWSTR lpNewFileName, LPVOID lpProgressRoutine, LPVOID lpData, LPVOID pbCancel, DWORD dwCopyFlags)');
# my $ret = $CopyFileExW->Call($lpExistingFileName, $lpNewFileName, $lpProgressRoutine, $lpData, $pbCancel, $dwCopyFlags);
# lpExistingFileName : LPCWSTR -> LPCWSTR
# lpNewFileName : LPCWSTR -> LPCWSTR
# lpProgressRoutine : LPPROGRESS_ROUTINE optional -> LPVOID
# lpData : void* optional -> LPVOID
# pbCancel : BOOL* optional, in/out -> LPVOID
# dwCopyFlags : COPYFILE_FLAGS -> DWORD
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。
# コールバック(関数ポインタ)は Perl sub を直接渡せません。Win32::API::Callback を使用してください。
# Unicode(-W): LPCWSTR/LPWSTR は Win32::API が UTF-16 変換を行う。

関連項目

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