Copy Class

Definition

Namespace:

Microsoft.Build.Tasks

Assembly:

Microsoft.Build.Tasks.Core.dll

Package:

Microsoft.Build.Tasks.Core v17.11.4

Source:

Copy.cs

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, Microsoft::Build::Framework::IIncrementalTask

public class Copy : Microsoft.Build.Tasks.TaskExtension, Microsoft.Build.Framework.ICancelableTask, Microsoft.Build.Framework.IIncrementalTask

type Copy = class
    inherit TaskExtension
    interface IIncrementalTask
    interface ICancelableTask
    interface ITask

Public Class Copy
Inherits TaskExtension
Implements ICancelableTask, IIncrementalTask

Inheritance

Object

Task

TaskExtension

Copy

Implements

ICancelableTask ITask IIncrementalTask

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	Retrieves the IBuildEngine7 version of the build engine interface provided by the host. (Inherited from Task)
BuildEngine8	Retrieves the IBuildEngine8 version of the build engine interface provided by the host. (Inherited from Task)
BuildEngine9	Retrieves the IBuildEngine9 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
FailIfNotIncremental
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. Gets or sets a value that indicates 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. Gets or sets the number of times to attempt to copy, if all previous attempts failed. 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. Gets or sets the delay, in milliseconds, between any necessary retries.
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.
SourceFolders
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. Gets or sets a value that indicates whether to use Hard Links for the copied files rather than copy the files, if it's possible to do so.
UseSymboliclinksIfPossible	Gets or sets a value that indicates whether to create symbolic links for the copied files rather than copy the files, if it's possible to do so.
WroteAtLeastOneFile

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.
Execute()	This API supports the product infrastructure and is not intended to be used directly from your code. Standard entry point.