Copy Class

Definition

A task that copies files.

This API supports the product infrastructure and is not intended to be used directly from your code.

public ref class Copy : Microsoft::Build::Tasks::TaskExtension, Microsoft::Build::Framework::ICancelableTask
public ref class Copy : Microsoft::Build::Tasks::TaskExtension
public class Copy : Microsoft.Build.Tasks.TaskExtension, Microsoft.Build.Framework.ICancelableTask
public class Copy : Microsoft.Build.Tasks.TaskExtension
type Copy = class
    inherit TaskExtension
    interface ICancelableTask
    interface ITask
type Copy = class
    inherit TaskExtension
Public Class Copy
Inherits TaskExtension
Implements ICancelableTask
Public Class Copy
Inherits TaskExtension
Inheritance
Implements

Constructors

Copy()

This API supports the product infrastructure and is not intended to be used directly from your code.

Constructor.

Properties

BuildEngine

The build engine automatically sets this property to allow tasks to call back into it.

(Inherited from Task)
BuildEngine2

The build engine automatically sets this property to allow tasks to call back into it. This is a convenience property so that task authors inheriting from this class do not have to cast the value from IBuildEngine to IBuildEngine2.

(Inherited from Task)
BuildEngine3

Retrieves the IBuildEngine3 version of the build engine interface provided by the host.

(Inherited from Task)
BuildEngine4

Retrieves the IBuildEngine4 version of the build engine interface provided by the host.

(Inherited from Task)
BuildEngine5

Retrieves the IBuildEngine5 version of the build engine interface provided by the host.

(Inherited from Task)
BuildEngine6

Retrieves the IBuildEngine6 version of the build engine interface provided by the host.

(Inherited from Task)
BuildEngine7

Gets the version of the build engine interface provided by the host.

(Inherited from Task)
CopiedFiles

This API supports the product infrastructure and is not intended to be used directly from your code.

The subset of files that were successfully copied.

DestinationFiles

This API supports the product infrastructure and is not intended to be used directly from your code.

Gets or sets a list of files to copy the source files to.

DestinationFolder

This API supports the product infrastructure and is not intended to be used directly from your code.

Gets or sets the directory to which you want to copy the files.

ErrorIfLinkFails

Fail if unable to create a symbolic or hard link instead of falling back to copy

HelpKeywordPrefix

Gets or sets the prefix used to compose help keywords from string resource names. If a task does not have help keywords associated with its messages, it can ignore this property or set it to null. If the prefix is set to an empty string, then string resource names will be used verbatim as help keywords. For an example of how this prefix is used, see the TaskLoggingHelper.LogErrorWithCodeFromResources(string, object[]) method.

(Inherited from Task)
HostObject

The build engine sets this property if the host IDE has associated a host object with this particular task.

(Inherited from Task)
Log

This API supports the product infrastructure and is not intended to be used directly from your code.

Gets an instance of a TaskLoggingHelperExtension class containing task logging methods.

(Inherited from TaskExtension)
OverwriteReadOnlyFiles

This API supports the product infrastructure and is not intended to be used directly from your code.

Whether to overwrite files in the destination that have the read-only attribute set.

Retries

This API supports the product infrastructure and is not intended to be used directly from your code.

How many times to attempt to copy, if all previous attempts failed. Defaults to zero. Warning: using retries may mask a synchronization problem in your build process.

RetryDelayMilliseconds

This API supports the product infrastructure and is not intended to be used directly from your code.

Delay between any necessary retries. Defaults to Microsoft.Build.Tasks.Copy.RetryDelayMillisecondsDefault

SkipUnchangedFiles

This API supports the product infrastructure and is not intended to be used directly from your code.

Gets or sets a Boolean value that indicates whether the Copy task should skip the copying of files that are unchanged between the source and destination.

SourceFiles

This API supports the product infrastructure and is not intended to be used directly from your code.

Gets or sets the files to copy.

TaskResources

Gets or sets the task's culture-specific resources. Derived classes should register their resources either during construction, or via this property, if they have localized strings.

(Inherited from Task)
UseHardlinksIfPossible

This API supports the product infrastructure and is not intended to be used directly from your code.

Create Hard Links for the copied files rather than copy the files if possible to do so

UseSymboliclinksIfPossible

Create Symbolic Links for the copied files rather than copy the files if possible to do so

Methods

Cancel()

This API supports the product infrastructure and is not intended to be used directly from your code.

Stop and return (in an undefined state) as soon as possible.

Equals(Object)

Determines whether the specified object is equal to the current object.

(Inherited from Object)
Execute()

This API supports the product infrastructure and is not intended to be used directly from your code.

Standard entry point.

GetHashCode()

Serves as the default hash function.

(Inherited from Object)
GetType()

Gets the Type of the current instance.

(Inherited from Object)
MemberwiseClone()

Creates a shallow copy of the current Object.

(Inherited from Object)
ToString()

Returns a string that represents the current object.

(Inherited from Object)

Applies to