Copy Task
Copies files to a new location in the file system.
Parameters
The following table describes the parameters of the Copy task.
Parameter |
Description |
|---|---|
CopiedFiles |
Optional ITaskItem[] output parameter. Contains the items that were successfully copied. |
DestinationFiles |
Optional ITaskItem[] parameter. Specifies the list of files to copy the source files to. This list is expected to be a one-to-one mapping with the list specified in the SourceFiles parameter. That is, the first file specified in SourceFiles will be copied to the first location specified in DestinationFiles, and so forth. |
DestinationFolder |
Optional ITaskItem parameter. Specifies the directory to which you want to copy the files. This must be a directory, not a file. If the directory does not exist, it is created automatically. |
OverwriteReadOnlyFiles |
Optional Boolean parameter. Overwrite files even if they are marked as read only files |
Retries |
Optional Int32 parameter. Specifies how many times to attempt to copy, if all previous attempts have failed. Defaults to zero. Note: The use of retries can mask a synchronization problem in your build process. |
RetryDelayMilliseconds |
Optional Int32 parameter. Specifies the delay between any necessary retries. Defaults to the RetryDelayMillisecondsDefault argument, which is passed to the CopyTask constructor. |
SkipUnchangedFiles |
Optional Boolean parameter. If true, skips the copying of files that are unchanged between the source and destination. The Copy task considers files to be unchanged if they have the same size and the same last modified time. Note If you set this parameter to true, you should not use dependency analysis on the containing target, because that only runs the task if the last-modified times of the source files are newer than the last-modified times of the destination files. |
SourceFiles |
Required ITaskItem[] parameter. Specifies the files to copy. |
UseHardlinksIfPossible |
Optional Boolean parameter. If true, creates Hard Links for the copied files instead of copying the files. |
Remarks
Either the DestinationFolder or the DestinationFiles parameter must be specified, but not both. If both are specified, the task fails and an error is logged.
In addition to the parameters listed above, this task inherits parameters from the TaskExtension class, which itself inherits from the Task class. For a list of these additional parameters and their descriptions, see TaskExtension Base Class.
Example
The following example copies the items in the MySourceFiles item collection into the folder c:\MyProject\Destination.
<Project xmlns="https://schemas.microsoft.com/developer/msbuild/2003">
<ItemGroup>
<MySourceFiles Include="a.cs;b.cs;c.cs"/>
</ItemGroup>
<Target Name="CopyFiles">
<Copy
SourceFiles="@(MySourceFiles)"
DestinationFolder="c:\MyProject\Destination"
/>
</Target>
</Project>
The following example demonstrates how to do a recursive copy. This project copies all of the files recursively from c:\MySourceTree into c:\MyDestinationTree, while maintaining the directory structure.
<Project xmlns="https://schemas.microsoft.com/developer/msbuild/2003">
<ItemGroup>
<MySourceFiles Include="c:\MySourceTree\**\*.*"/>
</ItemGroup>
<Target Name="CopyFiles">
<Copy
SourceFiles="@(MySourceFiles)"
DestinationFiles="@(MySourceFiles->'c:\MyDestinationTree\%(RecursiveDir)%(Filename)%(Extension)')"
/>
</Target>
</Project>