Edit

COPYFILE2_COPY_PHASE enumeration (winbase.h)

  • Article

Indicates the phase of a copy at the time of an error. This is used in the Error structure embedded in the COPYFILE2_MESSAGE structure.

Syntax

typedef enum _COPYFILE2_COPY_PHASE {
  COPYFILE2_PHASE_NONE = 0,
  COPYFILE2_PHASE_PREPARE_SOURCE,
  COPYFILE2_PHASE_PREPARE_DEST,
  COPYFILE2_PHASE_READ_SOURCE,
  COPYFILE2_PHASE_WRITE_DESTINATION,
  COPYFILE2_PHASE_SERVER_COPY,
  COPYFILE2_PHASE_NAMEGRAFT_COPY,
  COPYFILE2_PHASE_MAX
} COPYFILE2_COPY_PHASE;

Constants

 
COPYFILE2_PHASE_NONE
Value: 0
The copy had not yet started processing.
COPYFILE2_PHASE_PREPARE_SOURCE
The source was being prepared including opening a handle to the source. This phase happens once per stream
copy operation.
COPYFILE2_PHASE_PREPARE_DEST
The destination was being prepared including opening a handle to the destination. This phase happens once
per stream copy operation.
COPYFILE2_PHASE_READ_SOURCE
The source file was being read. This phase happens one or more times per stream copy operation.
COPYFILE2_PHASE_WRITE_DESTINATION
The destination file was being written. This phase happens one or more times per stream copy
operation.
COPYFILE2_PHASE_SERVER_COPY
Both the source and destination were on the same remote server and the copy was being processed remotely.
This phase happens once per stream copy operation.
COPYFILE2_PHASE_NAMEGRAFT_COPY
The copy operation was processing symbolic links and/or reparse points. This phase happens once per file
copy operation.
COPYFILE2_PHASE_MAX
One greater than the maximum value. Valid values for this enumeration will be less than this value.

Remarks

To compile an application that uses this enumeration, define the _WIN32_WINNT macro as 0x0601 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_MESSAGE

CopyFile2

File Management Enumerations