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

CopyFile2

関数
拡張パラメータを指定してファイルをコピーする。
DLLKERNEL32.dll呼出規約winapi対応OSwindows8.0
📘 Microsoft Learn (日本語) · English

シグネチャ

// KERNEL32.dll
#include <windows.h>

HRESULT CopyFile2(
    LPCWSTR pwszExistingFileName,
    LPCWSTR pwszNewFileName,
    COPYFILE2_EXTENDED_PARAMETERS* pExtendedParameters   // optional
);

パラメーター

名前型方向説明
pwszExistingFileNameLPCWSTRin

既存のファイルの名前。

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

ヒント Windows 10 バージョン 1607 以降では、"\\?\" を付加することなく MAX_PATH 文字数制限を解除するようにオプトインできます。詳細については、ファイル、パス、名前空間の名前付けの「最大パス長の制限」セクションを参照してください。
lpExistingFileName が存在しない場合、CopyFile2 関数は失敗し、HRESULT_FROM_WIN32(ERROR_FILE_NOT_FOUND) を返します。
pwszNewFileNameLPCWSTRin

新しいファイルの名前。

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

ヒント Windows 10 バージョン 1607 以降では、"\\?\" を付加することなく MAX_PATH 文字数制限を解除するようにオプトインできます。詳細については、ファイル、パス、名前空間の名前付けの「最大パス長の制限」セクションを参照してください。
pExtendedParametersCOPYFILE2_EXTENDED_PARAMETERS*inoptionalCOPYFILE2_EXTENDED_PARAMETERS 構造体への任意指定のアドレス。

戻り値の型: HRESULT

公式ドキュメント

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

戻り値

関数が成功した場合、戻り値を SUCCEEDED マクロに渡すと TRUE を返します。

戻り値 説明
S_OK
 コピー操作が正常に完了しました。
HRESULT_FROM_WIN32(ERROR_REQUEST_PAUSED)
 CopyFile2ProgressRoutine コールバック関数からの COPYFILE2_PROGRESS_PAUSE の返却により、コピー操作が一時停止されました。
HRESULT_FROM_WIN32(ERROR_REQUEST_ABORTED)
 CopyFile2ProgressRoutine コールバック関数からの COPYFILE2_PROGRESS_CANCEL または COPYFILE2_PROGRESS_STOP の返却により、コピー操作が中止されました。
HRESULT_FROM_WIN32(ERROR_ALREADY_EXISTS)
 pExtendedParameters パラメーターを通じて渡された COPYFILE2_EXTENDED_PARAMETERS 構造体の dwCopyFlags メンバーに COPY_FILE_FAIL_IF_EXISTS フラグが含まれており、競合する名前が存在していました。
HRESULT_FROM_WIN32(ERROR_FILE_EXISTS)
 pExtendedParameters パラメーターを通じて渡された COPYFILE2_EXTENDED_PARAMETERS 構造体の dwCopyFlags メンバーに COPY_FILE_FAIL_IF_EXISTS フラグが含まれており、競合する名前が存在していました。

解説(Remarks)

この関数は、拡張属性、OLE 構造化ストレージ、NTFS ファイルシステムの代替データストリーム、およびファイル属性を保持します。既存のファイルのセキュリティ属性は新しいファイルにはコピーされません。セキュリティ属性をコピーするには、SHFileOperation 関数を使用してください。

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

この関数を使用するアプリケーションをコンパイルするには、_WIN32_WINNT マクロを _WIN32_WINNT_WIN8 以降として定義します。詳細については、Windows ヘッダーの使用を参照してください。

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

テクノロジ サポート
Server Message Block (SMB) 3.0 プロトコル はい
SMB 3.0 Transparent Failover (TFO) はい
SMB 3.0 with Scale-out File Shares (SO) はい
Cluster Shared Volume File System (CsvFS) はい
Resilient File System (ReFS) はい

Windows 10 バージョン 1903 および Windows Server 2022 以降では、この関数の pExtendedParameters 引数に渡される COPYFILE2_EXTENDED_PARAMETERS 構造体の dwCopyFlags フィールドに対して、新しい値 COPY_FILE_REQUEST_COMPRESSED_TRAFFIC がサポートされます。この新しい値は、コピー操作中に基盤となる転送チャネルがデータを圧縮することを要求します。この要求はすべてのメディアでサポートされるとは限らず、その場合は無視されます。圧縮の属性とパラメーター(計算量、メモリ使用量)はこの API を通じて構成することはできず、異なる OS リリース間で変更される可能性があります。Windows 10 では、このフラグは SMB 共有上に存在するファイルで、ネゴシエートされた SMB プロトコルバージョンが SMB v3.1.1 以降の場合にサポートされます。

出典・ライセンス: 上記「公式ドキュメント」の内容は Microsoft の Win32 API ドキュメント(MicrosoftDocs/sdk-api)を日本語に翻訳・改変したものです。© Microsoft Corporation. CC BY 4.0 で提供。
Microsoft 公式リファレンス: 英語 (en-us) · 日本語 (ja-jp) · 原文ソース (GitHub)

各言語での呼び出し定義

// KERNEL32.dll
#include <windows.h>

HRESULT CopyFile2(
    LPCWSTR pwszExistingFileName,
    LPCWSTR pwszNewFileName,
    COPYFILE2_EXTENDED_PARAMETERS* pExtendedParameters   // optional
);
[DllImport("KERNEL32.dll", ExactSpelling = true)]
static extern int CopyFile2(
    [MarshalAs(UnmanagedType.LPWStr)] string pwszExistingFileName,   // LPCWSTR
    [MarshalAs(UnmanagedType.LPWStr)] string pwszNewFileName,   // LPCWSTR
    IntPtr pExtendedParameters   // COPYFILE2_EXTENDED_PARAMETERS* optional
);
<DllImport("KERNEL32.dll", ExactSpelling:=True)>
Public Shared Function CopyFile2(
    <MarshalAs(UnmanagedType.LPWStr)> pwszExistingFileName As String,   ' LPCWSTR
    <MarshalAs(UnmanagedType.LPWStr)> pwszNewFileName As String,   ' LPCWSTR
    pExtendedParameters As IntPtr   ' COPYFILE2_EXTENDED_PARAMETERS* optional
) As Integer
End Function
' pwszExistingFileName : LPCWSTR
' pwszNewFileName : LPCWSTR
' pExtendedParameters : COPYFILE2_EXTENDED_PARAMETERS* optional
Declare PtrSafe Function CopyFile2 Lib "kernel32" ( _
    ByVal pwszExistingFileName As LongPtr, _
    ByVal pwszNewFileName As LongPtr, _
    ByVal pExtendedParameters As LongPtr) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。
import ctypes
from ctypes import wintypes

CopyFile2 = ctypes.windll.kernel32.CopyFile2
CopyFile2.restype = ctypes.c_int
CopyFile2.argtypes = [
    wintypes.LPCWSTR,  # pwszExistingFileName : LPCWSTR
    wintypes.LPCWSTR,  # pwszNewFileName : LPCWSTR
    ctypes.c_void_p,  # pExtendedParameters : COPYFILE2_EXTENDED_PARAMETERS* optional
]
require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('KERNEL32.dll')
CopyFile2 = Fiddle::Function.new(
  lib['CopyFile2'],
  [
    Fiddle::TYPE_VOIDP,  # pwszExistingFileName : LPCWSTR
    Fiddle::TYPE_VOIDP,  # pwszNewFileName : LPCWSTR
    Fiddle::TYPE_VOIDP,  # pExtendedParameters : COPYFILE2_EXTENDED_PARAMETERS* optional
  ],
  Fiddle::TYPE_INT)
#[link(name = "kernel32")]
extern "system" {
    fn CopyFile2(
        pwszExistingFileName: *const u16,  // LPCWSTR
        pwszNewFileName: *const u16,  // LPCWSTR
        pExtendedParameters: *mut COPYFILE2_EXTENDED_PARAMETERS  // COPYFILE2_EXTENDED_PARAMETERS* optional
    ) -> i32;
}
// crates: windows-sys provides ready-made bindings for this API.
$sig = @"
[DllImport("KERNEL32.dll")]
public static extern int CopyFile2([MarshalAs(UnmanagedType.LPWStr)] string pwszExistingFileName, [MarshalAs(UnmanagedType.LPWStr)] string pwszNewFileName, IntPtr pExtendedParameters);
"@
$api = Add-Type -MemberDefinition $sig -Name 'KERNEL32_CopyFile2' -Namespace Win32 -PassThru
# $api::CopyFile2(pwszExistingFileName, pwszNewFileName, pExtendedParameters)
#uselib "KERNEL32.dll"
#func global CopyFile2 "CopyFile2" sptr, sptr, sptr
; CopyFile2 pwszExistingFileName, pwszNewFileName, varptr(pExtendedParameters)   ; 戻り値は stat
; pwszExistingFileName : LPCWSTR -> "sptr"
; pwszNewFileName : LPCWSTR -> "sptr"
; pExtendedParameters : COPYFILE2_EXTENDED_PARAMETERS* optional -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。
出力引数: 
#uselib "KERNEL32.dll"
#cfunc global CopyFile2 "CopyFile2" wstr, wstr, var
; res = CopyFile2(pwszExistingFileName, pwszNewFileName, pExtendedParameters)
; pwszExistingFileName : LPCWSTR -> "wstr"
; pwszNewFileName : LPCWSTR -> "wstr"
; pExtendedParameters : COPYFILE2_EXTENDED_PARAMETERS* optional -> "var"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。
出力引数: 
; HRESULT CopyFile2(LPCWSTR pwszExistingFileName, LPCWSTR pwszNewFileName, COPYFILE2_EXTENDED_PARAMETERS* pExtendedParameters)
#uselib "KERNEL32.dll"
#cfunc global CopyFile2 "CopyFile2" wstr, wstr, var
; res = CopyFile2(pwszExistingFileName, pwszNewFileName, pExtendedParameters)
; pwszExistingFileName : LPCWSTR -> "wstr"
; pwszNewFileName : LPCWSTR -> "wstr"
; pExtendedParameters : COPYFILE2_EXTENDED_PARAMETERS* optional -> "var"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。
import (
	"golang.org/x/sys/windows"
	"unsafe"
)

var (
	kernel32 = windows.NewLazySystemDLL("KERNEL32.dll")
	procCopyFile2 = kernel32.NewProc("CopyFile2")
)

// pwszExistingFileName (LPCWSTR), pwszNewFileName (LPCWSTR), pExtendedParameters (COPYFILE2_EXTENDED_PARAMETERS* optional)
r1, _, err := procCopyFile2.Call(
	uintptr(unsafe.Pointer(windows.StringToUTF16Ptr(pwszExistingFileName))),
	uintptr(unsafe.Pointer(windows.StringToUTF16Ptr(pwszNewFileName))),
	uintptr(pExtendedParameters),
)
_ = err  // syscall.Errno (valid when the call sets last-error)
_ = r1   // HRESULT
function CopyFile2(
  pwszExistingFileName: PWideChar;   // LPCWSTR
  pwszNewFileName: PWideChar;   // LPCWSTR
  pExtendedParameters: Pointer   // COPYFILE2_EXTENDED_PARAMETERS* optional
): Integer; stdcall;
  external 'KERNEL32.dll' name 'CopyFile2';
result := DllCall("KERNEL32\CopyFile2"
    , "WStr", pwszExistingFileName   ; LPCWSTR
    , "WStr", pwszNewFileName   ; LPCWSTR
    , "Ptr", pExtendedParameters   ; COPYFILE2_EXTENDED_PARAMETERS* optional
    , "Int")   ; return: HRESULT
●CopyFile2(pwszExistingFileName, pwszNewFileName, pExtendedParameters) = DLL("KERNEL32.dll", "int CopyFile2(char*, char*, void*)")
# 呼び出し: CopyFile2(pwszExistingFileName, pwszNewFileName, pExtendedParameters)
# pwszExistingFileName : LPCWSTR -> "char*"
# pwszNewFileName : LPCWSTR -> "char*"
# pExtendedParameters : COPYFILE2_EXTENDED_PARAMETERS* optional -> "void*"
# なでしこ1は32bit・ANSI(Shift_JIS)。文字列=char*(ANSI)、ポインタ/ハンドル=void*(4byte)。
const std = @import("std");

extern "kernel32" fn CopyFile2(
    pwszExistingFileName: [*c]const u16, // LPCWSTR
    pwszNewFileName: [*c]const u16, // LPCWSTR
    pExtendedParameters: [*c]COPYFILE2_EXTENDED_PARAMETERS // COPYFILE2_EXTENDED_PARAMETERS* optional
) callconv(std.os.windows.WINAPI) i32;
proc CopyFile2(
    pwszExistingFileName: WideCString,  # LPCWSTR
    pwszNewFileName: WideCString,  # LPCWSTR
    pExtendedParameters: ptr COPYFILE2_EXTENDED_PARAMETERS  # COPYFILE2_EXTENDED_PARAMETERS* optional
): int32 {.importc: "CopyFile2", stdcall, dynlib: "KERNEL32.dll".}
pragma(lib, "kernel32");
extern(Windows)
int CopyFile2(
    const(wchar)* pwszExistingFileName,   // LPCWSTR
    const(wchar)* pwszNewFileName,   // LPCWSTR
    COPYFILE2_EXTENDED_PARAMETERS* pExtendedParameters   // COPYFILE2_EXTENDED_PARAMETERS* optional
);
ccall((:CopyFile2, "KERNEL32.dll"), stdcall, Int32,
      (Cwstring, Cwstring, Ptr{COPYFILE2_EXTENDED_PARAMETERS}),
      pwszExistingFileName, pwszNewFileName, pExtendedParameters)
# pwszExistingFileName : LPCWSTR -> Cwstring
# pwszNewFileName : LPCWSTR -> Cwstring
# pExtendedParameters : COPYFILE2_EXTENDED_PARAMETERS* optional -> Ptr{COPYFILE2_EXTENDED_PARAMETERS}
# stdcall は 32bit のみ意味を持つ(x64 では無視)。
local ffi = require("ffi")
ffi.cdef[[
int32_t CopyFile2(
    const uint16_t* pwszExistingFileName,
    const uint16_t* pwszNewFileName,
    void* pExtendedParameters);
]]
local kernel32 = ffi.load("kernel32")
-- kernel32.CopyFile2(pwszExistingFileName, pwszNewFileName, pExtendedParameters)
-- pwszExistingFileName : LPCWSTR
-- pwszNewFileName : LPCWSTR
-- pExtendedParameters : COPYFILE2_EXTENDED_PARAMETERS* optional
-- 構造体/GUIDへのポインタは cdef が通るよう void* で表記(実型は各引数コメント参照)。値渡し構造体・enum は対応する typedef を cdef に追加すること。
const koffi = require('koffi');
const lib = koffi.load('KERNEL32.dll');
const CopyFile2 = lib.func('__stdcall', 'CopyFile2', 'int32_t', ['str16', 'str16', 'void *']);
// CopyFile2(pwszExistingFileName, pwszNewFileName, pExtendedParameters)
// pwszExistingFileName : LPCWSTR -> 'str16'
// pwszNewFileName : LPCWSTR -> 'str16'
// pExtendedParameters : COPYFILE2_EXTENDED_PARAMETERS* optional -> 'void *'
// 出力ポインタは koffi.out(...) で包む。構造体は koffi.struct で定義。
const lib = Deno.dlopen("KERNEL32.dll", {
  CopyFile2: { parameters: ["buffer", "buffer", "pointer"], result: "i32" },
});
// lib.symbols.CopyFile2(pwszExistingFileName, pwszNewFileName, pExtendedParameters)
// pwszExistingFileName : LPCWSTR -> "buffer"
// pwszNewFileName : LPCWSTR -> "buffer"
// pExtendedParameters : COPYFILE2_EXTENDED_PARAMETERS* optional -> "pointer"
// 文字列引数は "buffer"(NUL 終端のバイト列を Uint8Array で渡す)。
// 値渡し構造体は { struct: [ ...field types... ] } を使用。
<?php
$ffi = FFI::cdef(<<<C
int32_t CopyFile2(
    const uint16_t* pwszExistingFileName,
    const uint16_t* pwszNewFileName,
    void* pExtendedParameters);
C, "KERNEL32.dll");
// $ffi->CopyFile2(pwszExistingFileName, pwszNewFileName, pExtendedParameters);
// pwszExistingFileName : LPCWSTR
// pwszNewFileName : LPCWSTR
// pExtendedParameters : COPYFILE2_EXTENDED_PARAMETERS* 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);
    int CopyFile2(
        WString pwszExistingFileName,   // LPCWSTR
        WString pwszNewFileName,   // LPCWSTR
        Pointer pExtendedParameters   // COPYFILE2_EXTENDED_PARAMETERS* optional
    );
}
@[Link("kernel32")]
lib LibKERNEL32
  fun CopyFile2 = CopyFile2(
    pwszExistingFileName : UInt16*,   # LPCWSTR
    pwszNewFileName : UInt16*,   # LPCWSTR
    pExtendedParameters : COPYFILE2_EXTENDED_PARAMETERS*   # COPYFILE2_EXTENDED_PARAMETERS* optional
  ) : Int32
end
# 構造体/GUID/enum は lib 内に対応する型定義が必要。
# 呼出規約: x64 は規約統一のため OK。x86(32bit)は WINAPI=stdcall だが Crystal の fun に stdcall 付与構文がなく非対応。
import 'dart:ffi';
import 'package:ffi/ffi.dart';

typedef CopyFile2Native = Int32 Function(Pointer<Utf16>, Pointer<Utf16>, Pointer<Void>);
typedef CopyFile2Dart = int Function(Pointer<Utf16>, Pointer<Utf16>, Pointer<Void>);
final CopyFile2 = DynamicLibrary.open('KERNEL32.dll')
    .lookupFunction<CopyFile2Native, CopyFile2Dart>('CopyFile2');
// pwszExistingFileName : LPCWSTR -> Pointer<Utf16>
// pwszNewFileName : LPCWSTR -> Pointer<Utf16>
// pExtendedParameters : COPYFILE2_EXTENDED_PARAMETERS* optional -> Pointer<Void>
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。
{$mode objfpc}{$H+}
function CopyFile2(
  pwszExistingFileName: PWideChar;   // LPCWSTR
  pwszNewFileName: PWideChar;   // LPCWSTR
  pExtendedParameters: Pointer   // COPYFILE2_EXTENDED_PARAMETERS* optional
): Integer; stdcall;
  external 'KERNEL32.dll' name 'CopyFile2';
import Foreign
import Foreign.C.Types
import Foreign.C.String

foreign import stdcall safe "CopyFile2"
  c_CopyFile2 :: CWString -> CWString -> Ptr () -> IO Int32
-- pwszExistingFileName : LPCWSTR -> CWString
-- pwszNewFileName : LPCWSTR -> CWString
-- pExtendedParameters : COPYFILE2_EXTENDED_PARAMETERS* optional -> Ptr ()
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。
open Ctypes
open Foreign

let copyfile2 =
  foreign "CopyFile2"
    ((ptr uint16_t) @-> (ptr uint16_t) @-> (ptr void) @-> returning int32_t)
(* pwszExistingFileName : LPCWSTR -> (ptr uint16_t) *)
(* pwszNewFileName : LPCWSTR -> (ptr uint16_t) *)
(* pExtendedParameters : COPYFILE2_EXTENDED_PARAMETERS* 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 ("CopyFile2" copy-file2 :convention :stdcall) :int32
  (pwsz-existing-file-name (:string :encoding :utf-16le))   ; LPCWSTR
  (pwsz-new-file-name (:string :encoding :utf-16le))   ; LPCWSTR
  (p-extended-parameters :pointer))   ; COPYFILE2_EXTENDED_PARAMETERS* optional
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。
use Win32::API;
my $CopyFile2 = Win32::API::More->new('KERNEL32',
    'int CopyFile2(LPCWSTR pwszExistingFileName, LPCWSTR pwszNewFileName, LPVOID pExtendedParameters)');
# my $ret = $CopyFile2->Call($pwszExistingFileName, $pwszNewFileName, $pExtendedParameters);
# pwszExistingFileName : LPCWSTR -> LPCWSTR
# pwszNewFileName : LPCWSTR -> LPCWSTR
# pExtendedParameters : COPYFILE2_EXTENDED_PARAMETERS* optional -> LPVOID
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。

関連項目

類似 API
使用する型