CopyFileExA
関数シグネチャ
// KERNEL32.dll (ANSI / -A)
#include <windows.h>
BOOL CopyFileExA(
LPCSTR lpExistingFileName,
LPCSTR lpNewFileName,
LPPROGRESS_ROUTINE lpProgressRoutine, // optional
void* lpData, // optional
BOOL* pbCancel, // optional
COPYFILE_FLAGS dwCopyFlags
);パラメーター
| 名前 | 型 | 方向 | 説明 | ||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| lpExistingFileName | LPCSTR | in | 既存のファイルの名前です。 既定では、名前は MAX_PATH 文字に制限されます。この制限を 32,767 ワイド文字まで拡張するには、パスの先頭に "\\?\" を付加します。詳細については、ファイル、パス、名前空間の名前付けを参照してください。 ヒント
Windows 10 バージョン 1607 以降では、"\\?\" を付加せずに MAX_PATH の制限を解除することを選択できます。詳細については、ファイル、パス、名前空間の名前付けの「Maximum Path Length Limitation」セクションを参照してください。 lpExistingFileName が存在しない場合、 CopyFileEx 関数は失敗し、 GetLastError 関数は ERROR_FILE_NOT_FOUND を返します。 | ||||||||||||||||
| lpNewFileName | LPCSTR | in | 新しいファイルの名前です。 既定では、名前は MAX_PATH 文字に制限されます。この制限を 32,767 ワイド文字まで拡張するには、パスの先頭に "\\?\" を付加します。詳細については、ファイル、パス、名前空間の名前付けを参照してください。 ヒント
Windows 10 バージョン 1607 以降では、"\\?\" を付加せずに MAX_PATH の制限を解除することを選択できます。詳細については、ファイル、パス、名前空間の名前付けの「Maximum Path Length Limitation」セクションを参照してください。 | ||||||||||||||||
| lpProgressRoutine | LPPROGRESS_ROUTINE | inoptional | ファイルの別の部分がコピーされるたびに呼び出される、LPPROGRESS_ROUTINE 型のコールバック関数のアドレスです。このパラメーターは NULL にすることができます。進行状況コールバック関数の詳細については、 CopyProgressRoutine 関数を参照してください。 | ||||||||||||||||
| lpData | void* | inoptional | コールバック関数に渡される引数です。このパラメーターは NULL にすることができます。 | ||||||||||||||||
| pbCancel | BOOL* | inoutoptional | コピー操作中にこのフラグが TRUE に設定されると、操作はキャンセルされます。 それ以外の場合、コピー操作は完了まで続行されます。 | ||||||||||||||||
| dwCopyFlags | COPYFILE_FLAGS | in | ファイルのコピー方法を指定するフラグです。このパラメーターには、次の値の組み合わせを 指定できます。
|
戻り値の型: BOOL
公式ドキュメント
既存のファイルを新しいファイルにコピーし、コールバック関数を通じてその進行状況をアプリケーションに通知します。(CopyFileExA)
戻り値
関数が成功した場合、戻り値は 0 以外の値になります。
関数が失敗した場合、戻り値は 0 になります。拡張エラー情報を取得するには、 GetLastError を呼び出します。
ユーザーが操作をキャンセルしたことにより lpProgressRoutine が PROGRESS_CANCEL を返した場合、CopyFileEx は 0 を返し、 GetLastError は ERROR_REQUEST_ABORTED を返します。この場合、部分的にコピーされたコピー先ファイルは 削除されます。
ユーザーが操作を停止したことにより lpProgressRoutine が PROGRESS_STOP を返した場合、CopyFileEx は 0 を返し、 GetLastError は ERROR_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 を使用してコピーされる場合、この 関数は、コピー元ファイルの暗号化に使用された鍵でコピー先ファイルを暗号化しようとします。これが できない場合、この関数は既定の鍵でコピー先ファイルを暗号化しようとします。これら両方の 方法ができない場合、CopyFileEx は ERROR_ENCRYPTION_FAILED エラーコードで失敗します。コピー先ファイルを暗号化できない場合でも CopyFileEx にコピー操作を完了させたい場合は、 CopyFileEx の呼び出しの dwCopyFlags パラメーターの値として COPY_FILE_ALLOW_DECRYPTED_DESTINATION を含めます。
COPY_FILE_COPY_SYMLINK が指定されている場合、次の規則が適用されます。
- コピー元ファイルがシンボリックリンクの場合、ターゲットファイルではなくシンボリックリンクがコピーされます。
- コピー元ファイルがシンボリックリンクでない場合、動作に変化はありません。
- コピー先ファイルが既存のシンボリックリンクの場合、ターゲットファイルではなくシンボリックリンクが 上書きされます。
- COPY_FILE_FAIL_IF_EXISTS も指定されており、コピー先ファイルが 既存のシンボリックリンクである場合、操作はすべてのケースで失敗します。
- COPY_FILE_FAIL_IF_EXISTS も指定されており、コピー先ファイルが 既存のシンボリックリンクである場合、操作はシンボリックリンクのターゲットが存在する場合にのみ失敗します。
- COPY_FILE_FAIL_IF_EXISTS が指定されていない場合、動作に変化はありません。
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) | はい |
| Scale-out File Shares (SO) を使用した SMB 3.0 | はい |
| クラスター共有ボリュームファイルシステム (CsvFS) | はい |
| 回復性のあるファイルシステム (ReFS) | はい |
winbase.h ヘッダーは、CopyFileEx を、UNICODE プリプロセッサ定数の定義に基づいてこの関数の ANSI 版または Unicode 版を自動的に選択するエイリアスとして定義します。エンコーディング中立のエイリアスの使用を、エンコーディング中立でないコードと混在させると、コンパイルエラーや実行時エラーを引き起こす不一致につながる可能性があります。詳細については、関数プロトタイプの規則を参照してください。
Microsoft 公式リファレンス: 英語 (en-us) · 日本語 (ja-jp) · 原文ソース (GitHub)
各言語での呼び出し定義
// KERNEL32.dll (ANSI / -A)
#include <windows.h>
BOOL CopyFileExA(
LPCSTR lpExistingFileName,
LPCSTR lpNewFileName,
LPPROGRESS_ROUTINE lpProgressRoutine, // optional
void* lpData, // optional
BOOL* pbCancel, // optional
COPYFILE_FLAGS dwCopyFlags
);[return: MarshalAs(UnmanagedType.Bool)]
[DllImport("KERNEL32.dll", CharSet = CharSet.Ansi, SetLastError = true, ExactSpelling = true)]
static extern bool CopyFileExA(
[MarshalAs(UnmanagedType.LPStr)] string lpExistingFileName, // LPCSTR
[MarshalAs(UnmanagedType.LPStr)] string lpNewFileName, // LPCSTR
IntPtr lpProgressRoutine, // LPPROGRESS_ROUTINE optional
IntPtr lpData, // void* optional
IntPtr pbCancel, // BOOL* optional, in/out
uint dwCopyFlags // COPYFILE_FLAGS
);<DllImport("KERNEL32.dll", CharSet:=CharSet.Ansi, SetLastError:=True, ExactSpelling:=True)>
Public Shared Function CopyFileExA(
<MarshalAs(UnmanagedType.LPStr)> lpExistingFileName As String, ' LPCSTR
<MarshalAs(UnmanagedType.LPStr)> lpNewFileName As String, ' LPCSTR
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 : LPCSTR
' lpNewFileName : LPCSTR
' lpProgressRoutine : LPPROGRESS_ROUTINE optional
' lpData : void* optional
' pbCancel : BOOL* optional, in/out
' dwCopyFlags : COPYFILE_FLAGS
Declare PtrSafe Function CopyFileExA Lib "kernel32" ( _
ByVal lpExistingFileName As String, _
ByVal lpNewFileName As String, _
ByVal lpProgressRoutine As LongPtr, _
ByVal lpData As LongPtr, _
ByVal pbCancel As LongPtr, _
ByVal dwCopyFlags As Long) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。import ctypes
from ctypes import wintypes
CopyFileExA = ctypes.windll.kernel32.CopyFileExA
CopyFileExA.restype = wintypes.BOOL
CopyFileExA.argtypes = [
wintypes.LPCSTR, # lpExistingFileName : LPCSTR
wintypes.LPCSTR, # lpNewFileName : LPCSTR
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')
CopyFileExA = Fiddle::Function.new(
lib['CopyFileExA'],
[
Fiddle::TYPE_VOIDP, # lpExistingFileName : LPCSTR
Fiddle::TYPE_VOIDP, # lpNewFileName : LPCSTR
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)#[link(name = "kernel32")]
extern "system" {
fn CopyFileExA(
lpExistingFileName: *const u8, // LPCSTR
lpNewFileName: *const u8, // LPCSTR
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.Ansi, SetLastError = true)]
public static extern bool CopyFileExA([MarshalAs(UnmanagedType.LPStr)] string lpExistingFileName, [MarshalAs(UnmanagedType.LPStr)] string lpNewFileName, IntPtr lpProgressRoutine, IntPtr lpData, IntPtr pbCancel, uint dwCopyFlags);
"@
$api = Add-Type -MemberDefinition $sig -Name 'KERNEL32_CopyFileExA' -Namespace Win32 -PassThru
# $api::CopyFileExA(lpExistingFileName, lpNewFileName, lpProgressRoutine, lpData, pbCancel, dwCopyFlags)#uselib "KERNEL32.dll"
#func global CopyFileExA "CopyFileExA" sptr, sptr, sptr, sptr, sptr, sptr
; CopyFileExA lpExistingFileName, lpNewFileName, lpProgressRoutine, lpData, varptr(pbCancel), dwCopyFlags ; 戻り値は stat
; lpExistingFileName : LPCSTR -> "sptr"
; lpNewFileName : LPCSTR -> "sptr"
; lpProgressRoutine : LPPROGRESS_ROUTINE optional -> "sptr"
; lpData : void* optional -> "sptr"
; pbCancel : BOOL* optional, in/out -> "sptr"
; dwCopyFlags : COPYFILE_FLAGS -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。#uselib "KERNEL32.dll" #cfunc global CopyFileExA "CopyFileExA" str, str, sptr, sptr, var, int ; res = CopyFileExA(lpExistingFileName, lpNewFileName, lpProgressRoutine, lpData, pbCancel, dwCopyFlags) ; lpExistingFileName : LPCSTR -> "str" ; lpNewFileName : LPCSTR -> "str" ; lpProgressRoutine : LPPROGRESS_ROUTINE optional -> "sptr" ; lpData : void* optional -> "sptr" ; pbCancel : BOOL* optional, in/out -> "var" ; dwCopyFlags : COPYFILE_FLAGS -> "int" ; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。#uselib "KERNEL32.dll" #cfunc global CopyFileExA "CopyFileExA" str, str, sptr, sptr, sptr, int ; res = CopyFileExA(lpExistingFileName, lpNewFileName, lpProgressRoutine, lpData, varptr(pbCancel), dwCopyFlags) ; lpExistingFileName : LPCSTR -> "str" ; lpNewFileName : LPCSTR -> "str" ; lpProgressRoutine : LPPROGRESS_ROUTINE optional -> "sptr" ; lpData : void* optional -> "sptr" ; pbCancel : BOOL* optional, in/out -> "sptr" ; dwCopyFlags : COPYFILE_FLAGS -> "int" ; ※出力/バッファ引数はポインタ方式(token=sptr / 呼び出しは varptr(変数))。
; BOOL CopyFileExA(LPCSTR lpExistingFileName, LPCSTR lpNewFileName, LPPROGRESS_ROUTINE lpProgressRoutine, void* lpData, BOOL* pbCancel, COPYFILE_FLAGS dwCopyFlags) #uselib "KERNEL32.dll" #cfunc global CopyFileExA "CopyFileExA" str, str, intptr, intptr, var, int ; res = CopyFileExA(lpExistingFileName, lpNewFileName, lpProgressRoutine, lpData, pbCancel, dwCopyFlags) ; lpExistingFileName : LPCSTR -> "str" ; lpNewFileName : LPCSTR -> "str" ; lpProgressRoutine : LPPROGRESS_ROUTINE optional -> "intptr" ; lpData : void* optional -> "intptr" ; pbCancel : BOOL* optional, in/out -> "var" ; dwCopyFlags : COPYFILE_FLAGS -> "int" ; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。; BOOL CopyFileExA(LPCSTR lpExistingFileName, LPCSTR lpNewFileName, LPPROGRESS_ROUTINE lpProgressRoutine, void* lpData, BOOL* pbCancel, COPYFILE_FLAGS dwCopyFlags) #uselib "KERNEL32.dll" #cfunc global CopyFileExA "CopyFileExA" str, str, intptr, intptr, intptr, int ; res = CopyFileExA(lpExistingFileName, lpNewFileName, lpProgressRoutine, lpData, varptr(pbCancel), dwCopyFlags) ; lpExistingFileName : LPCSTR -> "str" ; lpNewFileName : LPCSTR -> "str" ; lpProgressRoutine : LPPROGRESS_ROUTINE optional -> "intptr" ; lpData : void* optional -> "intptr" ; pbCancel : BOOL* optional, in/out -> "intptr" ; dwCopyFlags : COPYFILE_FLAGS -> "int" ; ※出力/バッファ引数はポインタ方式(token=intptr / 呼び出しは varptr(変数))。
import (
"golang.org/x/sys/windows"
"unsafe"
)
var (
kernel32 = windows.NewLazySystemDLL("KERNEL32.dll")
procCopyFileExA = kernel32.NewProc("CopyFileExA")
)
// lpExistingFileName (LPCSTR), lpNewFileName (LPCSTR), lpProgressRoutine (LPPROGRESS_ROUTINE optional), lpData (void* optional), pbCancel (BOOL* optional, in/out), dwCopyFlags (COPYFILE_FLAGS)
r1, _, err := procCopyFileExA.Call(
uintptr(unsafe.Pointer(windows.BytePtrFromString(lpExistingFileName))),
uintptr(unsafe.Pointer(windows.BytePtrFromString(lpNewFileName))),
uintptr(lpProgressRoutine),
uintptr(lpData),
uintptr(pbCancel),
uintptr(dwCopyFlags),
)
_ = err // syscall.Errno (valid when the call sets last-error)
_ = r1 // BOOLfunction CopyFileExA(
lpExistingFileName: PAnsiChar; // LPCSTR
lpNewFileName: PAnsiChar; // LPCSTR
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 'CopyFileExA';result := DllCall("KERNEL32\CopyFileExA"
, "AStr", lpExistingFileName ; LPCSTR
, "AStr", lpNewFileName ; LPCSTR
, "Ptr", lpProgressRoutine ; LPPROGRESS_ROUTINE optional
, "Ptr", lpData ; void* optional
, "Ptr", pbCancel ; BOOL* optional, in/out
, "UInt", dwCopyFlags ; COPYFILE_FLAGS
, "Int") ; return: BOOL●CopyFileExA(lpExistingFileName, lpNewFileName, lpProgressRoutine, lpData, pbCancel, dwCopyFlags) = DLL("KERNEL32.dll", "bool CopyFileExA(char*, char*, void*, void*, void*, dword)")
# 呼び出し: CopyFileExA(lpExistingFileName, lpNewFileName, lpProgressRoutine, lpData, pbCancel, dwCopyFlags)
# lpExistingFileName : LPCSTR -> "char*"
# lpNewFileName : LPCSTR -> "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)。const std = @import("std");
extern "kernel32" fn CopyFileExA(
lpExistingFileName: [*c]const u8, // LPCSTR
lpNewFileName: [*c]const u8, // LPCSTR
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;proc CopyFileExA(
lpExistingFileName: cstring, # LPCSTR
lpNewFileName: cstring, # LPCSTR
lpProgressRoutine: pointer, # LPPROGRESS_ROUTINE optional
lpData: pointer, # void* optional
pbCancel: ptr int32, # BOOL* optional, in/out
dwCopyFlags: uint32 # COPYFILE_FLAGS
): int32 {.importc: "CopyFileExA", stdcall, dynlib: "KERNEL32.dll".}pragma(lib, "kernel32");
extern(Windows)
int CopyFileExA(
const(char)* lpExistingFileName, // LPCSTR
const(char)* lpNewFileName, // LPCSTR
void* lpProgressRoutine, // LPPROGRESS_ROUTINE optional
void* lpData, // void* optional
int* pbCancel, // BOOL* optional, in/out
uint dwCopyFlags // COPYFILE_FLAGS
);ccall((:CopyFileExA, "KERNEL32.dll"), stdcall, Int32,
(Cstring, Cstring, Ptr{Cvoid}, Ptr{Cvoid}, Ptr{Int32}, UInt32),
lpExistingFileName, lpNewFileName, lpProgressRoutine, lpData, pbCancel, dwCopyFlags)
# lpExistingFileName : LPCSTR -> Cstring
# lpNewFileName : LPCSTR -> Cstring
# 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 では無視)。local ffi = require("ffi")
ffi.cdef[[
int32_t CopyFileExA(
const char* lpExistingFileName,
const char* lpNewFileName,
void* lpProgressRoutine,
void* lpData,
int32_t* pbCancel,
uint32_t dwCopyFlags);
]]
local kernel32 = ffi.load("kernel32")
-- kernel32.CopyFileExA(lpExistingFileName, lpNewFileName, lpProgressRoutine, lpData, pbCancel, dwCopyFlags)
-- lpExistingFileName : LPCSTR
-- lpNewFileName : LPCSTR
-- lpProgressRoutine : LPPROGRESS_ROUTINE optional
-- lpData : void* optional
-- pbCancel : BOOL* optional, in/out
-- dwCopyFlags : COPYFILE_FLAGS
-- 構造体/GUIDへのポインタは cdef が通るよう void* で表記(実型は各引数コメント参照)。値渡し構造体・enum は対応する typedef を cdef に追加すること。const koffi = require('koffi');
const lib = koffi.load('KERNEL32.dll');
const CopyFileExA = lib.func('__stdcall', 'CopyFileExA', 'int32_t', ['str', 'str', 'void *', 'void *', 'int32_t *', 'uint32_t']);
// CopyFileExA(lpExistingFileName, lpNewFileName, lpProgressRoutine, lpData, pbCancel, dwCopyFlags)
// lpExistingFileName : LPCSTR -> 'str'
// lpNewFileName : LPCSTR -> 'str'
// 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", {
CopyFileExA: { parameters: ["buffer", "buffer", "pointer", "pointer", "pointer", "u32"], result: "i32" },
});
// lib.symbols.CopyFileExA(lpExistingFileName, lpNewFileName, lpProgressRoutine, lpData, pbCancel, dwCopyFlags)
// lpExistingFileName : LPCSTR -> "buffer"
// lpNewFileName : LPCSTR -> "buffer"
// lpProgressRoutine : LPPROGRESS_ROUTINE optional -> "pointer"
// lpData : void* optional -> "pointer"
// pbCancel : BOOL* optional, in/out -> "pointer"
// dwCopyFlags : COPYFILE_FLAGS -> "u32"
// 文字列は "buffer"。ANSI(-A) は new TextEncoder() で UTF-8/ANSI バイト列(末尾に \x00)を渡す。
// 値渡し構造体は { struct: [ ...field types... ] } を使用。<?php
$ffi = FFI::cdef(<<<C
int32_t CopyFileExA(
const char* lpExistingFileName,
const char* lpNewFileName,
void* lpProgressRoutine,
void* lpData,
int32_t* pbCancel,
uint32_t dwCopyFlags);
C, "KERNEL32.dll");
// $ffi->CopyFileExA(lpExistingFileName, lpNewFileName, lpProgressRoutine, lpData, pbCancel, dwCopyFlags);
// lpExistingFileName : LPCSTR
// lpNewFileName : LPCSTR
// 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.ASCII_OPTIONS);
boolean CopyFileExA(
String lpExistingFileName, // LPCSTR
String lpNewFileName, // LPCSTR
Callback lpProgressRoutine, // LPPROGRESS_ROUTINE optional
Pointer lpData, // void* optional
IntByReference pbCancel, // BOOL* optional, in/out
int dwCopyFlags // COPYFILE_FLAGS
);
}@[Link("kernel32")]
lib LibKERNEL32
fun CopyFileExA = CopyFileExA(
lpExistingFileName : UInt8*, # LPCSTR
lpNewFileName : UInt8*, # LPCSTR
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 CopyFileExANative = Int32 Function(Pointer<Utf8>, Pointer<Utf8>, Pointer<Void>, Pointer<Void>, Pointer<Int32>, Uint32);
typedef CopyFileExADart = int Function(Pointer<Utf8>, Pointer<Utf8>, Pointer<Void>, Pointer<Void>, Pointer<Int32>, int);
final CopyFileExA = DynamicLibrary.open('KERNEL32.dll')
.lookupFunction<CopyFileExANative, CopyFileExADart>('CopyFileExA');
// lpExistingFileName : LPCSTR -> Pointer<Utf8>
// lpNewFileName : LPCSTR -> Pointer<Utf8>
// 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 CopyFileExA(
lpExistingFileName: PAnsiChar; // LPCSTR
lpNewFileName: PAnsiChar; // LPCSTR
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 'CopyFileExA';import Foreign
import Foreign.C.Types
import Foreign.C.String
foreign import stdcall safe "CopyFileExA"
c_CopyFileExA :: CString -> CString -> Ptr () -> Ptr () -> Ptr CInt -> Word32 -> IO CInt
-- lpExistingFileName : LPCSTR -> CString
-- lpNewFileName : LPCSTR -> CString
-- 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 copyfileexa =
foreign "CopyFileExA"
(string @-> string @-> (ptr void) @-> (ptr void) @-> (ptr int32_t) @-> uint32_t @-> returning int32_t)
(* lpExistingFileName : LPCSTR -> string *)
(* lpNewFileName : LPCSTR -> string *)
(* 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 ("CopyFileExA" copy-file-ex-a :convention :stdcall) :int32
(lp-existing-file-name :string) ; LPCSTR
(lp-new-file-name :string) ; LPCSTR
(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 $CopyFileExA = Win32::API::More->new('KERNEL32',
'BOOL CopyFileExA(LPCSTR lpExistingFileName, LPCSTR lpNewFileName, LPVOID lpProgressRoutine, LPVOID lpData, LPVOID pbCancel, DWORD dwCopyFlags)');
# my $ret = $CopyFileExA->Call($lpExistingFileName, $lpNewFileName, $lpProgressRoutine, $lpData, $pbCancel, $dwCopyFlags);
# lpExistingFileName : LPCSTR -> LPCSTR
# lpNewFileName : LPCSTR -> LPCSTR
# 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 を使用してください。関連項目
- f CopyFileExW (Unicode版) — 進捗通知付きでファイルをコピーする(Unicode版)。
- f CopyFile2 — 拡張パラメータを指定してファイルをコピーする。
- f CopyFileA — 既存ファイルを新しいファイルへコピーする(ANSI版)。
- f CopyFileTransactedA — トランザクション内で進捗通知付きにファイルをコピーする(ANSI版)。
- f CreateFileA — ファイルやデバイスを作成または開いてハンドルを返す(ANSI版)。
- f MoveFileWithProgressA — 進捗通知付きでファイルを移動・改名する(ANSI版)。
- f TransmitFile — ファイルの内容を接続済みソケットへ転送する。