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

CopyFileTransactedW

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

シグネチャ

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

BOOL CopyFileTransactedW(
    LPCWSTR lpExistingFileName,
    LPCWSTR lpNewFileName,
    LPPROGRESS_ROUTINE lpProgressRoutine,   // optional
    void* lpData,   // optional
    BOOL* pbCancel,   // optional
    DWORD dwCopyFlags,
    HANDLE hTransaction
);

パラメーター

名前方向説明
lpExistingFileNameLPCWSTRin

既存ファイルの名前です。

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

ヒント

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

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

ファイルはローカルコンピューター上に存在する必要があります。そうでない場合、関数は失敗し、最後のエラーコードは ERROR_TRANSACTIONS_UNSUPPORTED_REMOTE に設定されます。

lpNewFileNameLPCWSTRin

新しいファイルの名前です。

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

ヒント

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

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

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

意味
COPY_FILE_COPY_SYMLINK
0x00000800
コピー元ファイルがシンボリックリンクの場合、コピー先ファイルも、コピー元のシンボリックリンクが指している ファイルと同じファイルを指すシンボリックリンクになります。
COPY_FILE_FAIL_IF_EXISTS
0x00000001
コピー先ファイルが既に存在する場合、コピー操作は直ちに失敗します。
COPY_FILE_OPEN_SOURCE_FOR_WRITE
0x00000004
ファイルがコピーされ、元のファイルは書き込みアクセス用に開かれます。
COPY_FILE_RESTARTABLE
0x00000002
コピーが失敗した場合に備えて、コピーの進行状況がコピー先ファイル内で追跡されます。失敗したコピーは、失敗した呼び出しで使用したのと同じ lpExistingFileName および lpNewFileName の値を指定することで、後で再開できます。コピー操作中に新しいファイルが複数回フラッシュされる可能性があるため、これによりコピー操作が大幅に遅くなることがあります。
hTransactionHANDLEinトランザクションへのハンドルです。このハンドルは CreateTransaction 関数によって返されます。

戻り値の型: BOOL

公式ドキュメント

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

戻り値

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

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

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

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

既にロールバックされたトランザクションのハンドルを指定してこの関数を呼び出そうとすると、 CopyFileTransactedERROR_TRANSACTION_NOT_ACTIVE または ERROR_INVALID_TRANSACTION のいずれかを返します。

解説(Remarks)

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

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

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

暗号化されたファイルは TxF ではサポートされていません。

COPY_FILE_COPY_SYMLINK を指定した場合、次の規則が適用されます。

COPY_FILE_COPY_SYMLINK を指定しなかった場合、次の規則が適用されます。

リンク追跡は TxF ではサポートされていません。

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

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

SMB 3.0 は TxF をサポートしていないことに注意してください。

メモ

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

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

CopyFileTransactedW = ctypes.windll.kernel32.CopyFileTransactedW
CopyFileTransactedW.restype = wintypes.BOOL
CopyFileTransactedW.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
    wintypes.DWORD,  # dwCopyFlags : DWORD
    wintypes.HANDLE,  # hTransaction : HANDLE
]
# GetLastError: use ctypes.GetLastError() (or ctypes.WinDLL(use_last_error=True))
require 'fiddle'
require 'fiddle/import'

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

var (
	kernel32 = windows.NewLazySystemDLL("KERNEL32.dll")
	procCopyFileTransactedW = kernel32.NewProc("CopyFileTransactedW")
)

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

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

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

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

let copyfiletransactedw =
  foreign "CopyFileTransactedW"
    ((ptr uint16_t) @-> (ptr uint16_t) @-> (ptr void) @-> (ptr void) @-> (ptr int32_t) @-> uint32_t @-> (ptr void) @-> 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 -> (ptr int32_t) *)
(* dwCopyFlags : DWORD -> uint32_t *)
(* hTransaction : HANDLE -> (ptr void) *)
(* foreign は cdecl 前提。x64 Windows では WINAPI と一致。構造体は ctypes structure を定義のこと。 *)
(cffi:define-foreign-library kernel32 (t "KERNEL32.dll"))
(cffi:use-foreign-library kernel32)

(cffi:defcfun ("CopyFileTransactedW" copy-file-transacted-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
  (dw-copy-flags :uint32)   ; DWORD
  (h-transaction :pointer))   ; HANDLE
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。
use Win32::API;
my $CopyFileTransactedW = Win32::API::More->new('KERNEL32',
    'BOOL CopyFileTransactedW(LPCWSTR lpExistingFileName, LPCWSTR lpNewFileName, LPVOID lpProgressRoutine, LPVOID lpData, LPVOID pbCancel, DWORD dwCopyFlags, HANDLE hTransaction)');
# my $ret = $CopyFileTransactedW->Call($lpExistingFileName, $lpNewFileName, $lpProgressRoutine, $lpData, $pbCancel, $dwCopyFlags, $hTransaction);
# lpExistingFileName : LPCWSTR -> LPCWSTR
# lpNewFileName : LPCWSTR -> LPCWSTR
# lpProgressRoutine : LPPROGRESS_ROUTINE optional -> LPVOID
# lpData : void* optional -> LPVOID
# pbCancel : BOOL* optional -> LPVOID
# dwCopyFlags : DWORD -> DWORD
# hTransaction : HANDLE -> HANDLE
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。
# コールバック(関数ポインタ)は Perl sub を直接渡せません。Win32::API::Callback を使用してください。
# Unicode(-W): LPCWSTR/LPWSTR は Win32::API が UTF-16 変換を行う。

関連項目

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