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

CopyFileA

関数
既存ファイルを新しいファイルへコピーする(ANSI版)。
DLLKERNEL32.dll文字セットANSI (-A)呼出規約winapiSetLastErrorあり対応OSWindows XP 以降

シグネチャ

// KERNEL32.dll  (ANSI / -A)
#include <windows.h>

BOOL CopyFileA(
    LPCSTR lpExistingFileName,
    LPCSTR lpNewFileName,
    BOOL bFailIfExists
);

パラメーター

名前方向説明
lpExistingFileNameLPCSTRin

既存のファイルの名前。

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

ヒント

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

lpExistingFileName が存在しない場合、 CopyFile は失敗し、 GetLastErrorERROR_FILE_NOT_FOUND を返します。

lpNewFileNameLPCSTRin

新しいファイルの名前。

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

ヒント

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

bFailIfExistsBOOLinこのパラメーターが TRUE で、 lpNewFileName で指定された新しいファイルが既に存在する場合、関数は失敗します。このパラメーターが FALSE で、新しいファイルが既に存在する場合、関数は既存のファイルを上書きして 成功します。

戻り値の型: BOOL

公式ドキュメント

既存のファイルを新しいファイルにコピーします。(CopyFileA)

戻り値

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

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

解説(Remarks)

既存のファイルのセキュリティリソースプロパティ(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_READONLY ファイル属性が設定されている場合、 CopyFile の呼び出しによって作成されたコピーにも FILE_ATTRIBUTE_READONLY ファイル属性が設定されます。詳細については、 ファイル属性の取得と変更 を参照してください。

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

CopyFile を使用して暗号化されたファイルをコピーする場合、 コピー元ファイルの暗号化に使用された鍵でコピー先ファイルを暗号化しようとします。これができない場合、 この関数は既定の鍵でコピー先ファイルを暗号化しようとします。 これらの方法のいずれも実行できない場合、CopyFileERROR_ENCRYPTION_FAILED エラーコードで失敗します。

シンボリックリンクの動作—コピー元ファイルがシンボリックリンクの場合、実際にコピーされるファイルは シンボリックリンクのターゲットです。

コピー先ファイルが既に存在し、シンボリックリンクである場合、シンボリックリンクのターゲットが コピー元ファイルによって上書きされます。

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

テクノロジ サポート
Server Message Block (SMB) 3.0 プロトコル はい
SMB 3.0 トランスペアレントフェールオーバー (TFO) はい
SMB 3.0 とスケールアウトファイル共有 (SO) はい
クラスター共有ボリュームファイルシステム (CsvFS) はい
回復性のあるファイルシステム (ReFS) はい

例については、 ファイル属性の取得と変更 を参照してください。

メモ

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

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

各言語での呼び出し定義

// KERNEL32.dll  (ANSI / -A)
#include <windows.h>

BOOL CopyFileA(
    LPCSTR lpExistingFileName,
    LPCSTR lpNewFileName,
    BOOL bFailIfExists
);
[return: MarshalAs(UnmanagedType.Bool)]
[DllImport("KERNEL32.dll", CharSet = CharSet.Ansi, SetLastError = true, ExactSpelling = true)]
static extern bool CopyFileA(
    [MarshalAs(UnmanagedType.LPStr)] string lpExistingFileName,   // LPCSTR
    [MarshalAs(UnmanagedType.LPStr)] string lpNewFileName,   // LPCSTR
    bool bFailIfExists   // BOOL
);
<DllImport("KERNEL32.dll", CharSet:=CharSet.Ansi, SetLastError:=True, ExactSpelling:=True)>
Public Shared Function CopyFileA(
    <MarshalAs(UnmanagedType.LPStr)> lpExistingFileName As String,   ' LPCSTR
    <MarshalAs(UnmanagedType.LPStr)> lpNewFileName As String,   ' LPCSTR
    bFailIfExists As Boolean   ' BOOL
) As <MarshalAs(UnmanagedType.Bool)> Boolean
End Function
' lpExistingFileName : LPCSTR
' lpNewFileName : LPCSTR
' bFailIfExists : BOOL
Declare PtrSafe Function CopyFileA Lib "kernel32" ( _
    ByVal lpExistingFileName As String, _
    ByVal lpNewFileName As String, _
    ByVal bFailIfExists As Long) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。
import ctypes
from ctypes import wintypes

CopyFileA = ctypes.windll.kernel32.CopyFileA
CopyFileA.restype = wintypes.BOOL
CopyFileA.argtypes = [
    wintypes.LPCSTR,  # lpExistingFileName : LPCSTR
    wintypes.LPCSTR,  # lpNewFileName : LPCSTR
    wintypes.BOOL,  # bFailIfExists : BOOL
]
# GetLastError: use ctypes.GetLastError() (or ctypes.WinDLL(use_last_error=True))
require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('KERNEL32.dll')
CopyFileA = Fiddle::Function.new(
  lib['CopyFileA'],
  [
    Fiddle::TYPE_VOIDP,  # lpExistingFileName : LPCSTR
    Fiddle::TYPE_VOIDP,  # lpNewFileName : LPCSTR
    Fiddle::TYPE_INT,  # bFailIfExists : BOOL
  ],
  Fiddle::TYPE_INT)
#[link(name = "kernel32")]
extern "system" {
    fn CopyFileA(
        lpExistingFileName: *const u8,  // LPCSTR
        lpNewFileName: *const u8,  // LPCSTR
        bFailIfExists: i32  // BOOL
    ) -> 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 CopyFileA([MarshalAs(UnmanagedType.LPStr)] string lpExistingFileName, [MarshalAs(UnmanagedType.LPStr)] string lpNewFileName, bool bFailIfExists);
"@
$api = Add-Type -MemberDefinition $sig -Name 'KERNEL32_CopyFileA' -Namespace Win32 -PassThru
# $api::CopyFileA(lpExistingFileName, lpNewFileName, bFailIfExists)
#uselib "KERNEL32.dll"
#func global CopyFileA "CopyFileA" sptr, sptr, sptr
; CopyFileA lpExistingFileName, lpNewFileName, bFailIfExists   ; 戻り値は stat
; lpExistingFileName : LPCSTR -> "sptr"
; lpNewFileName : LPCSTR -> "sptr"
; bFailIfExists : BOOL -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。
#uselib "KERNEL32.dll"
#cfunc global CopyFileA "CopyFileA" str, str, int
; res = CopyFileA(lpExistingFileName, lpNewFileName, bFailIfExists)
; lpExistingFileName : LPCSTR -> "str"
; lpNewFileName : LPCSTR -> "str"
; bFailIfExists : BOOL -> "int"
; BOOL CopyFileA(LPCSTR lpExistingFileName, LPCSTR lpNewFileName, BOOL bFailIfExists)
#uselib "KERNEL32.dll"
#cfunc global CopyFileA "CopyFileA" str, str, int
; res = CopyFileA(lpExistingFileName, lpNewFileName, bFailIfExists)
; lpExistingFileName : LPCSTR -> "str"
; lpNewFileName : LPCSTR -> "str"
; bFailIfExists : BOOL -> "int"
import (
	"golang.org/x/sys/windows"
	"unsafe"
)

var (
	kernel32 = windows.NewLazySystemDLL("KERNEL32.dll")
	procCopyFileA = kernel32.NewProc("CopyFileA")
)

// lpExistingFileName (LPCSTR), lpNewFileName (LPCSTR), bFailIfExists (BOOL)
r1, _, err := procCopyFileA.Call(
	uintptr(unsafe.Pointer(windows.BytePtrFromString(lpExistingFileName))),
	uintptr(unsafe.Pointer(windows.BytePtrFromString(lpNewFileName))),
	uintptr(bFailIfExists),
)
_ = err  // syscall.Errno (valid when the call sets last-error)
_ = r1   // BOOL
function CopyFileA(
  lpExistingFileName: PAnsiChar;   // LPCSTR
  lpNewFileName: PAnsiChar;   // LPCSTR
  bFailIfExists: BOOL   // BOOL
): BOOL; stdcall;
  external 'KERNEL32.dll' name 'CopyFileA';
result := DllCall("KERNEL32\CopyFileA"
    , "AStr", lpExistingFileName   ; LPCSTR
    , "AStr", lpNewFileName   ; LPCSTR
    , "Int", bFailIfExists   ; BOOL
    , "Int")   ; return: BOOL
●CopyFileA(lpExistingFileName, lpNewFileName, bFailIfExists) = DLL("KERNEL32.dll", "bool CopyFileA(char*, char*, bool)")
# 呼び出し: CopyFileA(lpExistingFileName, lpNewFileName, bFailIfExists)
# lpExistingFileName : LPCSTR -> "char*"
# lpNewFileName : LPCSTR -> "char*"
# bFailIfExists : BOOL -> "bool"
# なでしこ1は32bit・ANSI(Shift_JIS)。文字列=char*(ANSI)、ポインタ/ハンドル=void*(4byte)。
const std = @import("std");

extern "kernel32" fn CopyFileA(
    lpExistingFileName: [*c]const u8, // LPCSTR
    lpNewFileName: [*c]const u8, // LPCSTR
    bFailIfExists: i32 // BOOL
) callconv(std.os.windows.WINAPI) i32;
proc CopyFileA(
    lpExistingFileName: cstring,  # LPCSTR
    lpNewFileName: cstring,  # LPCSTR
    bFailIfExists: int32  # BOOL
): int32 {.importc: "CopyFileA", stdcall, dynlib: "KERNEL32.dll".}
pragma(lib, "kernel32");
extern(Windows)
int CopyFileA(
    const(char)* lpExistingFileName,   // LPCSTR
    const(char)* lpNewFileName,   // LPCSTR
    int bFailIfExists   // BOOL
);
ccall((:CopyFileA, "KERNEL32.dll"), stdcall, Int32,
      (Cstring, Cstring, Int32),
      lpExistingFileName, lpNewFileName, bFailIfExists)
# lpExistingFileName : LPCSTR -> Cstring
# lpNewFileName : LPCSTR -> Cstring
# bFailIfExists : BOOL -> Int32
# stdcall は 32bit のみ意味を持つ(x64 では無視)。
local ffi = require("ffi")
ffi.cdef[[
int32_t CopyFileA(
    const char* lpExistingFileName,
    const char* lpNewFileName,
    int32_t bFailIfExists);
]]
local kernel32 = ffi.load("kernel32")
-- kernel32.CopyFileA(lpExistingFileName, lpNewFileName, bFailIfExists)
-- lpExistingFileName : LPCSTR
-- lpNewFileName : LPCSTR
-- bFailIfExists : BOOL
-- 構造体/GUIDへのポインタは cdef が通るよう void* で表記(実型は各引数コメント参照)。値渡し構造体・enum は対応する typedef を cdef に追加すること。
const koffi = require('koffi');
const lib = koffi.load('KERNEL32.dll');
const CopyFileA = lib.func('__stdcall', 'CopyFileA', 'int32_t', ['str', 'str', 'int32_t']);
// CopyFileA(lpExistingFileName, lpNewFileName, bFailIfExists)
// lpExistingFileName : LPCSTR -> 'str'
// lpNewFileName : LPCSTR -> 'str'
// bFailIfExists : BOOL -> 'int32_t'
// 出力ポインタは koffi.out(...) で包む。構造体は koffi.struct で定義。
const lib = Deno.dlopen("KERNEL32.dll", {
  CopyFileA: { parameters: ["buffer", "buffer", "i32"], result: "i32" },
});
// lib.symbols.CopyFileA(lpExistingFileName, lpNewFileName, bFailIfExists)
// lpExistingFileName : LPCSTR -> "buffer"
// lpNewFileName : LPCSTR -> "buffer"
// bFailIfExists : BOOL -> "i32"
// 文字列は "buffer"。ANSI(-A) は new TextEncoder() で UTF-8/ANSI バイト列(末尾に \x00)を渡す。
// 値渡し構造体は { struct: [ ...field types... ] } を使用。
<?php
$ffi = FFI::cdef(<<<C
int32_t CopyFileA(
    const char* lpExistingFileName,
    const char* lpNewFileName,
    int32_t bFailIfExists);
C, "KERNEL32.dll");
// $ffi->CopyFileA(lpExistingFileName, lpNewFileName, bFailIfExists);
// lpExistingFileName : LPCSTR
// lpNewFileName : LPCSTR
// bFailIfExists : BOOL
// 構造体/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 CopyFileA(
        String lpExistingFileName,   // LPCSTR
        String lpNewFileName,   // LPCSTR
        boolean bFailIfExists   // BOOL
    );
}
@[Link("kernel32")]
lib LibKERNEL32
  fun CopyFileA = CopyFileA(
    lpExistingFileName : UInt8*,   # LPCSTR
    lpNewFileName : UInt8*,   # LPCSTR
    bFailIfExists : Int32   # BOOL
  ) : Int32
end
# 構造体/GUID/enum は lib 内に対応する型定義が必要。
# 呼出規約: x64 は規約統一のため OK。x86(32bit)は WINAPI=stdcall だが Crystal の fun に stdcall 付与構文がなく非対応。
import 'dart:ffi';
import 'package:ffi/ffi.dart';

typedef CopyFileANative = Int32 Function(Pointer<Utf8>, Pointer<Utf8>, Int32);
typedef CopyFileADart = int Function(Pointer<Utf8>, Pointer<Utf8>, int);
final CopyFileA = DynamicLibrary.open('KERNEL32.dll')
    .lookupFunction<CopyFileANative, CopyFileADart>('CopyFileA');
// lpExistingFileName : LPCSTR -> Pointer<Utf8>
// lpNewFileName : LPCSTR -> Pointer<Utf8>
// bFailIfExists : BOOL -> Int32
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。
{$mode objfpc}{$H+}
function CopyFileA(
  lpExistingFileName: PAnsiChar;   // LPCSTR
  lpNewFileName: PAnsiChar;   // LPCSTR
  bFailIfExists: BOOL   // BOOL
): BOOL; stdcall;
  external 'KERNEL32.dll' name 'CopyFileA';
import Foreign
import Foreign.C.Types
import Foreign.C.String

foreign import stdcall safe "CopyFileA"
  c_CopyFileA :: CString -> CString -> CInt -> IO CInt
-- lpExistingFileName : LPCSTR -> CString
-- lpNewFileName : LPCSTR -> CString
-- bFailIfExists : BOOL -> CInt
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。
open Ctypes
open Foreign

let copyfilea =
  foreign "CopyFileA"
    (string @-> string @-> int32_t @-> returning int32_t)
(* lpExistingFileName : LPCSTR -> string *)
(* lpNewFileName : LPCSTR -> string *)
(* bFailIfExists : BOOL -> int32_t *)
(* foreign は cdecl 前提。x64 Windows では WINAPI と一致。構造体は ctypes structure を定義のこと。 *)
(cffi:define-foreign-library kernel32 (t "KERNEL32.dll"))
(cffi:use-foreign-library kernel32)

(cffi:defcfun ("CopyFileA" copy-file-a :convention :stdcall) :int32
  (lp-existing-file-name :string)   ; LPCSTR
  (lp-new-file-name :string)   ; LPCSTR
  (b-fail-if-exists :int32))   ; BOOL
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。
use Win32::API;
my $CopyFileA = Win32::API::More->new('KERNEL32',
    'BOOL CopyFileA(LPCSTR lpExistingFileName, LPCSTR lpNewFileName, BOOL bFailIfExists)');
# my $ret = $CopyFileA->Call($lpExistingFileName, $lpNewFileName, $bFailIfExists);
# lpExistingFileName : LPCSTR -> LPCSTR
# lpNewFileName : LPCSTR -> LPCSTR
# bFailIfExists : BOOL -> BOOL
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。

関連項目

文字セット違い
類似 API
公式の関連項目