Edit

Share via

COPYFILE2_EXTENDED_PARAMETERS structure (winbase.h)

  • Article

Contains extended parameters for the CopyFile2 function.

Syntax

typedef struct COPYFILE2_EXTENDED_PARAMETERS {
  DWORD                       dwSize;
  DWORD                       dwCopyFlags;
  BOOL                        *pfCancel;
  PCOPYFILE2_PROGRESS_ROUTINE pProgressRoutine;
  PVOID                       pvCallbackContext;
} COPYFILE2_EXTENDED_PARAMETERS;

Members

dwSize

Contains the size of this structure, sizeof(COPYFILE2_EXTENDED_PARAMETERS).

dwCopyFlags

Contains a combination of zero or more of these flag values.

Value Meaning
COPY_FILE_FAIL_IF_EXISTS
0x00000001		 If the destination file exists the copy operation fails immediately. If a file or directory exists with the destination name then the CopyFile2 function call will fail with either HRESULT_FROM_WIN32(ERROR_ALREADY_EXISTS) or HRESULT_FROM_WIN32(ERROR_FILE_EXISTS). If COPY_FILE_RESUME_FROM_PAUSE is also specified then a failure is only triggered if the destination file does not have a valid restart header.
COPY_FILE_RESTARTABLE
0x00000002		 The file is copied in a manner that can be restarted if the same source and destination filenames are used again. This is slower.
COPY_FILE_OPEN_SOURCE_FOR_WRITE
0x00000004		 The file is copied and the source file is opened for write access.
COPY_FILE_ALLOW_DECRYPTED_DESTINATION
0x00000008		 The copy will be attempted even if the destination file cannot be encrypted.
COPY_FILE_COPY_SYMLINK
0x00000800		 If the source file is a symbolic link, the destination file is also a symbolic link pointing to the same file as the source symbolic link.
COPY_FILE_NO_BUFFERING
0x00001000		 The copy is performed using unbuffered I/O, bypassing the system cache resources. This flag is recommended for very large file copies. It is not recommended to pause copies that are using this flag.
COPY_FILE_REQUEST_SECURITY_PRIVILEGES
0x00002000		 The copy is attempted, specifying ACCESS_SYSTEM_SECURITY for the source file and ACCESS_SYSTEM_SECURITY \| WRITE_DAC \| WRITE_OWNER for the destination file. If these requests are denied the access request will be reduced to the highest privilege level for which access is granted. For more information see SACL Access Right. This can be used to allow the CopyFile2ProgressRoutine callback to perform operations requiring higher privileges, such as copying the security attributes for the file.
COPY_FILE_RESUME_FROM_PAUSE
0x00004000		 The destination file is examined to see if it was copied using COPY_FILE_RESTARTABLE. If so the copy is resumed. If not the file will be fully copied.
COPY_FILE_NO_OFFLOAD
0x00040000		 Do not attempt to use the Windows Copy Offload mechanism. This is not generally recommended.
COPY_FILE_IGNORE_EDP_BLOCK
0x00400000		 Instead of blocking, the file should be copied and encrypted on the destination if supported by the destination file system. Supported on Windows 10 and later.
COPY_FILE_IGNORE_SOURCE_ENCRYPTION
0x00800000		 Ignore the source file’s encrypted state. Supported on Windows 10 and later.
COPY_FILE_DONT_REQUEST_DEST_WRITE_DAC
0x02000000		 Don't request WRITE_DAC for the destination file access. Supported on Windows 10 and later.
COPY_FILE_OPEN_AND_COPY_REPARSE_POINT
0x00200000		 Always copy the reparse point regardless of type. It's the caller’s responsibility to understand the reparse point meaning. Supported on Windows 10, build 19041 and later.
COPY_FILE_DIRECTORY
0x00000080		 Indicates the source file is a directory file. When provided, the source file is opened with FILE_OPEN_FOR_BACKUP_INTENT. The directory file will have its alternate data streams, reparse point info, and EAs copied like a normal file. Supported in Windows 10, build 19041 and later.
COPY_FILE_SKIP_ALTERNATE_STREAMS
0x00008000		 Do not copy alternate data streams. Supported in Windows 10, build 19041 and later.
COPY_FILE_DISABLE_PRE_ALLOCATION
0x04000000		 Do not preallocate the destination file size before performing the copy. Supported in Windows 10, build 19041 and later.
COPY_FILE_ENABLE_LOW_FREE_SPACE_MODE
0x08000000		 Enable LowFreeSpace mode. No overlapped I/Os are used. ODX and SMB offload are not attempted. Supported in Windows 10, build 19041 and later.
COPY_FILE_REQUEST_COMPRESSED_TRAFFIC
0x10000000		 Request the underlying transfer channel compress the data during the copy operation. The request may not be supported for all mediums, in which case it is ignored. The compression attributes and parameters (computational complexity, memory usage) are not configurable through this API, and are subject to change between different OS releases. Supported in Windows Server 2022 and Windows 10, build 1903 and later. (On Windows 10, the flag is supported for files residing on SMB shares, where the negotiated SMB protocol version is SMB v3.1.1 or greater.)
COPY_FILE_ENABLE_SPARSE_COPY
0x20000000		 Enable retaining the sparse state of the file during copy. Supported in Windows 11, build 22H2 and later.

pfCancel

If this flag is set to TRUE during the copy operation then the copy operation is canceled.

pProgressRoutine

The optional address of a callback function of type PCOPYFILE2_PROGRESS_ROUTINE that is called each time another portion of the file has been copied. This parameter can be NULL. For more information on the progress callback function, see the CopyFile2ProgressRoutine callback function.

pvCallbackContext

A pointer to application-specific context information to be passed to the CopyFile2ProgressRoutine.

Remarks

To compile an application that uses this structure, define the _WIN32_WINNT macro as _WIN32_WINNT_WIN8 or later. For more information, see Using the Windows Headers.

Requirements

Requirement Value
Minimum supported client Windows 8 [desktop apps | UWP apps]
Minimum supported server Windows Server 2012 [desktop apps | UWP apps]
Header winbase.h (include Windows.h)

See also

CopyFile2

CopyFile2ProgressRoutine

File Management Structures

COPYFILE2_EXTENDED_PARAMETERS_V2