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

COPYFILE2_EXTENDED_PARAMETERS

構造体
サイズx64: 32 バイト / x86: 20 バイト

サイズ=各フィールドのバイト数(x64/x86 で異なる場合は x64/x86 と併記)。x64/x86 列=フィールドのバイトオフセット(HSPで dupptr / lpoke / wpoke 等に使用)。

フィールド

フィールドサイズx64x86説明
dwSizeDWORD4+0+0この構造体のサイズ sizeof(COPYFILE2_EXTENDED_PARAMETERS) を格納します。
dwCopyFlagsCOPYFILE_FLAGS4+4+4

次のフラグ値のうち 0 個以上を組み合わせた値を格納します。

意味
COPY_FILE_FAIL_IF_EXISTS
0x00000001
コピー先のファイルが存在する場合、コピー操作は直ちに失敗します。コピー先の名前を持つファイルまたはディレクトリが存在する場合、CopyFile2 関数の呼び出しは HRESULT_FROM_WIN32(ERROR_ALREADY_EXISTS) または HRESULT_FROM_WIN32(ERROR_FILE_EXISTS) のいずれかで失敗します。COPY_FILE_RESUME_FROM_PAUSE も同時に指定されている場合、失敗が発生するのはコピー先のファイルが有効な再開ヘッダーを持たないときのみです。
COPY_FILE_RESTARTABLE
0x00000002
同じコピー元とコピー先のファイル名が再度使用されたときに再開できる方法でファイルがコピーされます。この方法は低速です。
COPY_FILE_OPEN_SOURCE_FOR_WRITE
0x00000004
ファイルがコピーされ、コピー元のファイルは書き込みアクセスで開かれます。
COPY_FILE_ALLOW_DECRYPTED_DESTINATION
0x00000008
コピー先のファイルを暗号化できない場合でもコピーが試行されます。
COPY_FILE_COPY_SYMLINK
0x00000800
コピー元のファイルがシンボリックリンクの場合、コピー先のファイルも、コピー元のシンボリックリンクと同じファイルを指すシンボリックリンクになります。
COPY_FILE_NO_BUFFERING
0x00001000
システムキャッシュリソースをバイパスし、バッファーを使用しない I/O でコピーが実行されます。このフラグは非常に大きなファイルのコピーに推奨されます。このフラグを使用しているコピーを一時停止することは推奨されません。
COPY_FILE_REQUEST_SECURITY_PRIVILEGES
0x00002000
コピー元のファイルには ACCESS_SYSTEM_SECURITY を、コピー先のファイルには ACCESS_SYSTEM_SECURITY | WRITE_DAC | WRITE_OWNER を指定してコピーが試行されます。これらの要求が拒否された場合、アクセス要求はアクセスが許可される最上位の特権レベルまで引き下げられます。詳細については、SACL Access Right を参照してください。これにより、CopyFile2ProgressRoutine コールバックで、ファイルのセキュリティ属性のコピーなど、より高い特権を必要とする操作を実行できるようになります。
COPY_FILE_RESUME_FROM_PAUSE
0x00004000
コピー先のファイルが COPY_FILE_RESTARTABLE を使用してコピーされたかどうかが検査されます。そうであればコピーが再開されます。そうでなければファイルは完全にコピーされます。
COPY_FILE_NO_OFFLOAD
0x00040000
Windows のコピーオフロードメカニズムを使用しません。これは一般には推奨されません。
COPY_FILE_IGNORE_EDP_BLOCK
0x00400000
ブロックする代わりに、コピー先のファイルシステムがサポートしていれば、ファイルをコピーしてコピー先で暗号化します。Windows 10 以降でサポートされます。
COPY_FILE_IGNORE_SOURCE_ENCRYPTION
0x00800000
コピー元のファイルの暗号化状態を無視します。Windows 10 以降でサポートされます。
COPY_FILE_DONT_REQUEST_DEST_WRITE_DAC
0x02000000
コピー先のファイルアクセスに対して WRITE_DAC を要求しません。Windows 10 以降でサポートされます。
COPY_FILE_OPEN_AND_COPY_REPARSE_POINT
0x00200000
種類にかかわらず、常に再解析ポイントをコピーします。再解析ポイントの意味を理解するのは呼び出し元の責任です。Windows 10 ビルド 19041 以降でサポートされます。
COPY_FILE_DIRECTORY
0x00000080
コピー元のファイルがディレクトリファイルであることを示します。指定した場合、コピー元のファイルは FILE_OPEN_FOR_BACKUP_INTENT で開かれます。ディレクトリファイルは、通常のファイルと同様に代替データストリーム、再解析ポイント情報、および EA がコピーされます。Windows 10 ビルド 19041 以降でサポートされます。
COPY_FILE_SKIP_ALTERNATE_STREAMS
0x00008000
代替データストリームをコピーしません。Windows 10 ビルド 19041 以降でサポートされます。
COPY_FILE_DISABLE_PRE_ALLOCATION
0x04000000
コピーを実行する前に、コピー先のファイルサイズを事前に割り当てません。Windows 10 ビルド 19041 以降でサポートされます。
COPY_FILE_ENABLE_LOW_FREE_SPACE_MODE
0x08000000
LowFreeSpace モードを有効にします。オーバーラップ I/O は使用されません。ODX および SMB オフロードは試行されません。Windows 10 ビルド 19041 以降でサポートされます。
COPY_FILE_REQUEST_COMPRESSED_TRAFFIC
0x10000000
コピー操作中にデータを圧縮するよう、基になる転送チャネルに要求します。この要求はすべての媒体でサポートされるとは限らず、サポートされない場合は無視されます。圧縮の属性とパラメーター (計算量、メモリ使用量) はこの API からは構成できず、OS のリリースによって変更される可能性があります。Windows Server 2022 および Windows 10 ビルド 1903 以降でサポートされます。 (Windows 10 では、ネゴシエートされた SMB プロトコルのバージョンが SMB v3.1.1 以上である SMB 共有上に存在するファイルに対してこのフラグがサポートされます。)
COPY_FILE_ENABLE_SPARSE_COPY
0x20000000
コピー中にファイルのスパース状態を保持できるようにします。Windows 11 ビルド 22H2 以降でサポートされます。
pfCancelBOOL*8/4+8+8コピー操作中にこのフラグが TRUE に設定された場合、コピー操作は取り消されます。
pProgressRoutinePCOPYFILE2_PROGRESS_ROUTINE8/4+16+12ファイルの新たな部分がコピーされるたびに呼び出される、PCOPYFILE2_PROGRESS_ROUTINE 型のコールバック関数のアドレス (省略可能)。このパラメーターには NULL を指定できます。進行状況コールバック関数の詳細については、CopyFile2ProgressRoutine コールバック関数を参照してください。
pvCallbackContextvoid*8/4+24+16CopyFile2ProgressRoutine に渡される、アプリケーション固有のコンテキスト情報へのポインター。

公式ドキュメント

CopyFile2 関数の拡張パラメーターを格納します。

解説(Remarks)

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

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

各言語での定義

#include <windows.h>

// COPYFILE2_EXTENDED_PARAMETERS  (x64 32 / x86 20 バイト)
typedef struct COPYFILE2_EXTENDED_PARAMETERS {
    DWORD dwSize;
    COPYFILE_FLAGS dwCopyFlags;
    BOOL* pfCancel;
    PCOPYFILE2_PROGRESS_ROUTINE pProgressRoutine;
    void* pvCallbackContext;
} COPYFILE2_EXTENDED_PARAMETERS;
using System;
using System.Runtime.InteropServices;

[StructLayout(LayoutKind.Sequential, CharSet = CharSet.Unicode)]
public struct COPYFILE2_EXTENDED_PARAMETERS
{
    public uint dwSize;
    public uint dwCopyFlags;
    [MarshalAs(UnmanagedType.Bool)] public bool pfCancel;
    public IntPtr pProgressRoutine;
    public IntPtr pvCallbackContext;
}
Imports System.Runtime.InteropServices

<StructLayout(LayoutKind.Sequential, CharSet:=CharSet.Unicode)>
Public Structure COPYFILE2_EXTENDED_PARAMETERS
    Public dwSize As UInteger
    Public dwCopyFlags As UInteger
    <MarshalAs(UnmanagedType.Bool)> Public pfCancel As Boolean
    Public pProgressRoutine As IntPtr
    Public pvCallbackContext As IntPtr
End Structure
import ctypes
from ctypes import wintypes

class COPYFILE2_EXTENDED_PARAMETERS(ctypes.Structure):
    _fields_ = [
        ("dwSize", wintypes.DWORD),
        ("dwCopyFlags", wintypes.DWORD),
        ("pfCancel", ctypes.c_void_p),
        ("pProgressRoutine", ctypes.c_void_p),
        ("pvCallbackContext", ctypes.c_void_p),
    ]
#[repr(C)]
pub struct COPYFILE2_EXTENDED_PARAMETERS {
    pub dwSize: u32,
    pub dwCopyFlags: u32,
    pub pfCancel: *mut core::ffi::c_void,
    pub pProgressRoutine: *mut core::ffi::c_void,
    pub pvCallbackContext: *mut core::ffi::c_void,
}
import "golang.org/x/sys/windows"

type COPYFILE2_EXTENDED_PARAMETERS struct {
	dwSize uint32
	dwCopyFlags uint32
	pfCancel uintptr
	pProgressRoutine uintptr
	pvCallbackContext uintptr
}
type
  COPYFILE2_EXTENDED_PARAMETERS = record
    dwSize: DWORD;
    dwCopyFlags: DWORD;
    pfCancel: Pointer;
    pProgressRoutine: Pointer;
    pvCallbackContext: Pointer;
  end;
const COPYFILE2_EXTENDED_PARAMETERS = extern struct {
    dwSize: u32,
    dwCopyFlags: u32,
    pfCancel: ?*anyopaque,
    pProgressRoutine: ?*anyopaque,
    pvCallbackContext: ?*anyopaque,
};
type
  COPYFILE2_EXTENDED_PARAMETERS {.bycopy.} = object
    dwSize: uint32
    dwCopyFlags: uint32
    pfCancel: pointer
    pProgressRoutine: pointer
    pvCallbackContext: pointer
struct COPYFILE2_EXTENDED_PARAMETERS
{
    uint dwSize;
    uint dwCopyFlags;
    void* pfCancel;
    void* pProgressRoutine;
    void* pvCallbackContext;
}

HSP用 定義

HSP3.7/3.8 は構造体機能が無いため4byte整数配列(dim)+peek/poke で操作(32/64bitでサイズ・位置が異なる場合はタブで分割)。IronHSP は NSTRUCT(#defstruct/stdim/->)で32/64bit共通。

; HSP3.7/3.8 は構造体機能が無いため、4byte整数の配列変数で操作します。(x86 レイアウト)
; COPYFILE2_EXTENDED_PARAMETERS サイズ: 20 バイト(x86)
dim st, 5    ; 4byte整数×5(構造体サイズ 20 / 4 切り上げ)
; dwSize : DWORD (+0, 4byte)  st.0 = 値  /  値 = st.0   (lpoke/lpeek も可)
; dwCopyFlags : COPYFILE_FLAGS (+4, 4byte)  st.1 = 値  /  値 = st.1   (lpoke/lpeek も可)
; pfCancel : BOOL* (+8, 4byte)  st.2 = 値  /  値 = st.2   (lpoke/lpeek も可)
; pProgressRoutine : PCOPYFILE2_PROGRESS_ROUTINE (+12, 4byte)  st.3 = 値  /  値 = st.3   (lpoke/lpeek も可)
; pvCallbackContext : void* (+16, 4byte)  st.4 = 値  /  値 = st.4   (lpoke/lpeek も可)
; ※4byte境界の整数は添字 st.N(N=オフセット/4)で読み書き可。それ以外は peek/poke 系を使用。
; HSP3.7/3.8 は構造体機能が無いため、4byte整数の配列変数で操作します。(x64 レイアウト)
; COPYFILE2_EXTENDED_PARAMETERS サイズ: 32 バイト(x64)
dim st, 8    ; 4byte整数×8(構造体サイズ 32 / 4 切り上げ)
; dwSize : DWORD (+0, 4byte)  st.0 = 値  /  値 = st.0   (lpoke/lpeek も可)
; dwCopyFlags : COPYFILE_FLAGS (+4, 4byte)  st.1 = 値  /  値 = st.1   (lpoke/lpeek も可)
; pfCancel : BOOL* (+8, 8byte)  qpoke st,8,値 / qpeek(st,8)  ※IronHSPのみ。3.7/3.8は lpoke st,8,下位 : lpoke st,12,上位
; pProgressRoutine : PCOPYFILE2_PROGRESS_ROUTINE (+16, 8byte)  qpoke st,16,値 / qpeek(st,16)  ※IronHSPのみ。3.7/3.8は lpoke st,16,下位 : lpoke st,20,上位
; pvCallbackContext : void* (+24, 8byte)  qpoke st,24,値 / qpeek(st,24)  ※IronHSPのみ。3.7/3.8は lpoke st,24,下位 : lpoke st,28,上位
; ※4byte境界の整数は添字 st.N(N=オフセット/4)で読み書き可。それ以外は peek/poke 系を使用。
; IronHSP は NSTRUCT(構造体)をサポート。32bit/64bit どちらでも同じコードで動作します。
#defstruct global COPYFILE2_EXTENDED_PARAMETERS
    #field int dwSize
    #field int dwCopyFlags
    #field intptr pfCancel
    #field intptr pProgressRoutine
    #field intptr pvCallbackContext
#endstruct

stdim st, COPYFILE2_EXTENDED_PARAMETERS        ; NSTRUCT 変数を確保
st->dwSize = 100
mes "dwSize=" + st->dwSize