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
lpNewFileNameLPCWSTRin
lpProgressRoutineLPPROGRESS_ROUTINEinoptional
lpDatavoid*inoptional
pbCancelBOOL*inoutoptional
dwCopyFlagsCOPYFILE_FLAGSin

戻り値の型: BOOL

各言語での呼び出し定義

// 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 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, 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, int, 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 -> "int"
; dwCopyFlags : COPYFILE_FLAGS -> "int"
; 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, int, 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 -> "int"
; dwCopyFlags : COPYFILE_FLAGS -> "int"
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 版の利用を推奨。