Repository navigation
Expand file tree
/
Copy pathCopy.xml
More file actions
321 lines (315 loc) · 17 KB
/
Copy pathCopy.xml
File metadata and controls
321 lines (315 loc) · 17 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
<Type Name="Copy" FullName="Microsoft.Build.Tasks.Copy">
<TypeSignature Language="C#" Value="public class Copy : Microsoft.Build.Tasks.TaskExtension, Microsoft.Build.Framework.ICancelableTask" />
<TypeSignature Language="ILAsm" Value=".class public auto ansi beforefieldinit Copy extends Microsoft.Build.Tasks.TaskExtension implements class Microsoft.Build.Framework.ICancelableTask, class Microsoft.Build.Framework.ITask" />
<TypeSignature Language="DocId" Value="T:Microsoft.Build.Tasks.Copy" />
<TypeSignature Language="VB.NET" Value="Public Class Copy
Inherits TaskExtension
Implements ICancelableTask" />
<TypeSignature Language="C++ CLI" Value="public ref class Copy : Microsoft::Build::Tasks::TaskExtension, Microsoft::Build::Framework::ICancelableTask" />
<AssemblyInfo>
<AssemblyName>Microsoft.Build.Tasks.v4.0</AssemblyName>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Base>
<BaseTypeName>Microsoft.Build.Tasks.TaskExtension</BaseTypeName>
</Base>
<Interfaces>
<Interface>
<InterfaceName>Microsoft.Build.Framework.ICancelableTask</InterfaceName>
</Interface>
</Interfaces>
<Docs>
<summary>Implements the <c>Copy</c> task. Use the <c>Copy</c> element in your project file to create and execute this task. For usage and parameter information, see [Copy Task](http://msdn.microsoft.com/library/a46ba9da-3e4e-4890-b4ea-09a099b6bc40).</summary>
<remarks>To be added.</remarks>
<forInternalUseOnly />
</Docs>
<Members>
<Member MemberName=".ctor">
<MemberSignature Language="C#" Value="public Copy ();" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig specialname rtspecialname instance void .ctor() cil managed" />
<MemberSignature Language="DocId" Value="M:Microsoft.Build.Tasks.Copy.#ctor" />
<MemberSignature Language="VB.NET" Value="Public Sub New ()" />
<MemberSignature Language="C++ CLI" Value="public:
 Copy();" />
<MemberType>Constructor</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Build.Tasks.v4.0</AssemblyName>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Parameters />
<Docs>
<summary>Initializes a new instance of the <see cref="T:Microsoft.Build.Tasks.Copy" /> class.</summary>
<remarks>To be added.</remarks>
<forInternalUseOnly />
</Docs>
</Member>
<Member MemberName="Cancel">
<MemberSignature Language="C#" Value="public void Cancel ();" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance void Cancel() cil managed" />
<MemberSignature Language="DocId" Value="M:Microsoft.Build.Tasks.Copy.Cancel" />
<MemberSignature Language="VB.NET" Value="Public Sub Cancel ()" />
<MemberSignature Language="C++ CLI" Value="public:
 virtual void Cancel();" />
<MemberType>Method</MemberType>
<Implements>
<InterfaceMember>M:Microsoft.Build.Framework.ICancelableTask.Cancel</InterfaceMember>
</Implements>
<AssemblyInfo>
<AssemblyName>Microsoft.Build.Tasks.v4.0</AssemblyName>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Void</ReturnType>
</ReturnValue>
<Parameters />
<Docs>
<summary>Stop and return (in an undefined state) as soon as possible.</summary>
<remarks>To be added.</remarks>
<forInternalUseOnly />
</Docs>
</Member>
<Member MemberName="CopiedFiles">
<MemberSignature Language="C#" Value="public Microsoft.Build.Framework.ITaskItem[] CopiedFiles { get; }" />
<MemberSignature Language="ILAsm" Value=".property instance class Microsoft.Build.Framework.ITaskItem[] CopiedFiles" />
<MemberSignature Language="DocId" Value="P:Microsoft.Build.Tasks.Copy.CopiedFiles" />
<MemberSignature Language="VB.NET" Value="Public ReadOnly Property CopiedFiles As ITaskItem()" />
<MemberSignature Language="C++ CLI" Value="public:
 property cli::array <Microsoft::Build::Framework::ITaskItem ^> ^ CopiedFiles { cli::array <Microsoft::Build::Framework::ITaskItem ^> ^ get(); };" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Build.Tasks.v4.0</AssemblyName>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Attributes>
<Attribute>
<AttributeName>Microsoft.Build.Framework.Output</AttributeName>
</Attribute>
</Attributes>
<ReturnValue>
<ReturnType>Microsoft.Build.Framework.ITaskItem[]</ReturnType>
</ReturnValue>
<Docs>
<summary>Gets the items that were successfully copied.</summary>
<value>The items that were successfully copied.</value>
<remarks>To be added.</remarks>
<forInternalUseOnly />
</Docs>
</Member>
<Member MemberName="DestinationFiles">
<MemberSignature Language="C#" Value="public Microsoft.Build.Framework.ITaskItem[] DestinationFiles { get; set; }" />
<MemberSignature Language="ILAsm" Value=".property instance class Microsoft.Build.Framework.ITaskItem[] DestinationFiles" />
<MemberSignature Language="DocId" Value="P:Microsoft.Build.Tasks.Copy.DestinationFiles" />
<MemberSignature Language="VB.NET" Value="Public Property DestinationFiles As ITaskItem()" />
<MemberSignature Language="C++ CLI" Value="public:
 property cli::array <Microsoft::Build::Framework::ITaskItem ^> ^ DestinationFiles { cli::array <Microsoft::Build::Framework::ITaskItem ^> ^ get(); void set(cli::array <Microsoft::Build::Framework::ITaskItem ^> ^ value); };" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Build.Tasks.v4.0</AssemblyName>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Attributes>
<Attribute>
<AttributeName>Microsoft.Build.Framework.Output</AttributeName>
</Attribute>
</Attributes>
<ReturnValue>
<ReturnType>Microsoft.Build.Framework.ITaskItem[]</ReturnType>
</ReturnValue>
<Docs>
<summary>Gets or sets a list of files to copy the source files to.</summary>
<value>The list of files to copy the source files to.</value>
<remarks>
<format type="text/markdown"><![CDATA[
## Remarks
The list of destination files is expected to be a one-to-one mapping with the list specified in the <xref:Microsoft.Build.Tasks.Copy.SourceFiles%2A> property. That is, the first file specified in <xref:Microsoft.Build.Tasks.Copy.SourceFiles%2A> will be copied to the first location specified in <xref:Microsoft.Build.Tasks.Copy.DestinationFiles%2A>, and so forth.
]]></format>
</remarks>
<forInternalUseOnly />
</Docs>
</Member>
<Member MemberName="DestinationFolder">
<MemberSignature Language="C#" Value="public Microsoft.Build.Framework.ITaskItem DestinationFolder { get; set; }" />
<MemberSignature Language="ILAsm" Value=".property instance class Microsoft.Build.Framework.ITaskItem DestinationFolder" />
<MemberSignature Language="DocId" Value="P:Microsoft.Build.Tasks.Copy.DestinationFolder" />
<MemberSignature Language="VB.NET" Value="Public Property DestinationFolder As ITaskItem" />
<MemberSignature Language="C++ CLI" Value="public:
 property Microsoft::Build::Framework::ITaskItem ^ DestinationFolder { Microsoft::Build::Framework::ITaskItem ^ get(); void set(Microsoft::Build::Framework::ITaskItem ^ value); };" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Build.Tasks.v4.0</AssemblyName>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>Microsoft.Build.Framework.ITaskItem</ReturnType>
</ReturnValue>
<Docs>
<summary>Gets or sets the directory to which you want to copy the files.</summary>
<value>The directory to which you want to copy the files.</value>
<remarks>
<format type="text/markdown"><![CDATA[
## Remarks
The destination folder must be a directory, not a file. If the directory does not exist, it is created automatically.
]]></format>
</remarks>
<forInternalUseOnly />
</Docs>
</Member>
<Member MemberName="Execute">
<MemberSignature Language="C#" Value="public override bool Execute ();" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig virtual instance bool Execute() cil managed" />
<MemberSignature Language="DocId" Value="M:Microsoft.Build.Tasks.Copy.Execute" />
<MemberSignature Language="VB.NET" Value="Public Overrides Function Execute () As Boolean" />
<MemberSignature Language="C++ CLI" Value="public:
 override bool Execute();" />
<MemberType>Method</MemberType>
<Implements>
<InterfaceMember>M:Microsoft.Build.Framework.ITask.Execute</InterfaceMember>
</Implements>
<AssemblyInfo>
<AssemblyName>Microsoft.Build.Tasks.v4.0</AssemblyName>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Boolean</ReturnType>
</ReturnValue>
<Parameters />
<Docs>
<summary>Executes the <c>Copy</c> task.</summary>
<returns>
<see langword="true" /> if task execution succeeded; otherwise, <see langword="false" />.</returns>
<remarks>To be added.</remarks>
<forInternalUseOnly />
</Docs>
</Member>
<Member MemberName="OverwriteReadOnlyFiles">
<MemberSignature Language="C#" Value="public bool OverwriteReadOnlyFiles { get; set; }" />
<MemberSignature Language="ILAsm" Value=".property instance bool OverwriteReadOnlyFiles" />
<MemberSignature Language="DocId" Value="P:Microsoft.Build.Tasks.Copy.OverwriteReadOnlyFiles" />
<MemberSignature Language="VB.NET" Value="Public Property OverwriteReadOnlyFiles As Boolean" />
<MemberSignature Language="C++ CLI" Value="public:
 property bool OverwriteReadOnlyFiles { bool get(); void set(bool value); };" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Build.Tasks.v4.0</AssemblyName>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Boolean</ReturnType>
</ReturnValue>
<Docs>
<summary>Gets or sets a Boolean value that indicates whether to overwrite files even if they are marked as read only files.</summary>
<value>
<see langword="true" /> if the <c>Copy</c> task should overwrite files even if they are marked as read only files; otherwise, <see langword="false" />.</value>
<remarks>To be added.</remarks>
<forInternalUseOnly />
</Docs>
</Member>
<Member MemberName="Retries">
<MemberSignature Language="C#" Value="public int Retries { get; set; }" />
<MemberSignature Language="ILAsm" Value=".property instance int32 Retries" />
<MemberSignature Language="DocId" Value="P:Microsoft.Build.Tasks.Copy.Retries" />
<MemberSignature Language="VB.NET" Value="Public Property Retries As Integer" />
<MemberSignature Language="C++ CLI" Value="public:
 property int Retries { int get(); void set(int value); };" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Build.Tasks.v4.0</AssemblyName>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Int32</ReturnType>
</ReturnValue>
<Docs>
<summary>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.</summary>
<value>To be added.</value>
<remarks>To be added.</remarks>
<forInternalUseOnly />
</Docs>
</Member>
<Member MemberName="RetryDelayMilliseconds">
<MemberSignature Language="C#" Value="public int RetryDelayMilliseconds { get; set; }" />
<MemberSignature Language="ILAsm" Value=".property instance int32 RetryDelayMilliseconds" />
<MemberSignature Language="DocId" Value="P:Microsoft.Build.Tasks.Copy.RetryDelayMilliseconds" />
<MemberSignature Language="VB.NET" Value="Public Property RetryDelayMilliseconds As Integer" />
<MemberSignature Language="C++ CLI" Value="public:
 property int RetryDelayMilliseconds { int get(); void set(int value); };" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Build.Tasks.v4.0</AssemblyName>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Int32</ReturnType>
</ReturnValue>
<Docs>
<summary>Delay between any necessary retries. Defaults to <see cref="F:Microsoft.Build.Tasks.Copy.RetryDelayMillisecondsDefault" /></summary>
<value>To be added.</value>
<remarks>To be added.</remarks>
<forInternalUseOnly />
</Docs>
</Member>
<Member MemberName="SkipUnchangedFiles">
<MemberSignature Language="C#" Value="public bool SkipUnchangedFiles { get; set; }" />
<MemberSignature Language="ILAsm" Value=".property instance bool SkipUnchangedFiles" />
<MemberSignature Language="DocId" Value="P:Microsoft.Build.Tasks.Copy.SkipUnchangedFiles" />
<MemberSignature Language="VB.NET" Value="Public Property SkipUnchangedFiles As Boolean" />
<MemberSignature Language="C++ CLI" Value="public:
 property bool SkipUnchangedFiles { bool get(); void set(bool value); };" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Build.Tasks.v4.0</AssemblyName>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Boolean</ReturnType>
</ReturnValue>
<Docs>
<summary>Gets or sets a Boolean value that indicates whether the <c>Copy</c> task should skip the copying of files that are unchanged between the source and destination.</summary>
<value>
<see langword="true" /> if the <c>Copy</c> task should skip the copying of files that are unchanged between the source and destination; otherwise, <see langword="false" />.</value>
<remarks>
<format type="text/markdown"><![CDATA[
## Remarks
The `Copy` task considers files to be unchanged if they have the same size and the same last modified time.
]]></format>
</remarks>
<forInternalUseOnly />
</Docs>
</Member>
<Member MemberName="SourceFiles">
<MemberSignature Language="C#" Value="public Microsoft.Build.Framework.ITaskItem[] SourceFiles { get; set; }" />
<MemberSignature Language="ILAsm" Value=".property instance class Microsoft.Build.Framework.ITaskItem[] SourceFiles" />
<MemberSignature Language="DocId" Value="P:Microsoft.Build.Tasks.Copy.SourceFiles" />
<MemberSignature Language="VB.NET" Value="Public Property SourceFiles As ITaskItem()" />
<MemberSignature Language="C++ CLI" Value="public:
 property cli::array <Microsoft::Build::Framework::ITaskItem ^> ^ SourceFiles { cli::array <Microsoft::Build::Framework::ITaskItem ^> ^ get(); void set(cli::array <Microsoft::Build::Framework::ITaskItem ^> ^ value); };" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Build.Tasks.v4.0</AssemblyName>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Attributes>
<Attribute>
<AttributeName>Microsoft.Build.Framework.Required</AttributeName>
</Attribute>
</Attributes>
<ReturnValue>
<ReturnType>Microsoft.Build.Framework.ITaskItem[]</ReturnType>
</ReturnValue>
<Docs>
<summary>Gets or sets the files to copy.</summary>
<value>The files to copy.</value>
<remarks>To be added.</remarks>
<forInternalUseOnly />
</Docs>
</Member>
<Member MemberName="UseHardlinksIfPossible">
<MemberSignature Language="C#" Value="public bool UseHardlinksIfPossible { get; set; }" />
<MemberSignature Language="ILAsm" Value=".property instance bool UseHardlinksIfPossible" />
<MemberSignature Language="DocId" Value="P:Microsoft.Build.Tasks.Copy.UseHardlinksIfPossible" />
<MemberSignature Language="VB.NET" Value="Public Property UseHardlinksIfPossible As Boolean" />
<MemberSignature Language="C++ CLI" Value="public:
 property bool UseHardlinksIfPossible { bool get(); void set(bool value); };" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Build.Tasks.v4.0</AssemblyName>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Boolean</ReturnType>
</ReturnValue>
<Docs>
<summary>Indicates if hard links should be used.</summary>
<value>To be added.</value>
<remarks>To be added.</remarks>
<forInternalUseOnly />
</Docs>
</Member>
</Members>
</Type>