forked from SignalR/SignalR
-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathMSBuild.Community.Tasks.xml
10475 lines (10437 loc) · 486 KB
/
MSBuild.Community.Tasks.xml
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
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
<?xml version="1.0"?>
<doc>
<assembly>
<name>MSBuild.Community.Tasks</name>
</assembly>
<members>
<member name="T:MSBuild.Community.Tasks.AspNet.InstallAspNet">
<summary>
Installs and register script mappings for ASP.NET
</summary>
<remarks>Uses the aspnet_regiis.exe tool included with the .NET Framework.</remarks>
<example>
Install the latest version of ASP.NET on the server:
<code>
<![CDATA[ <InstallAspNet /> ]]>
</code>
</example><example>
Install the latest version of ASP.NET on the server, but do not update script maps:
<code>
<![CDATA[ <InstallAspNet ApplyScriptMaps="Never" /> ]]>
</code>
</example><example>
Install the script maps for ASP.NET 2.0 on a web directory on the default website:
<code>
<![CDATA[ <InstallAspNet Path="MyApplication" Version="Version20" /> ]]>
</code>
</example><example>
Install the script maps for ASP.NET 1.1 on a web directory on a non-default website:
<code>
<![CDATA[ <InstallAspNet Path="MyApplication" Version="W3SVC/3/Root/Version11" /> ]]>
</code>
</example><example>
Install client side script only for the latest version:
<code>
<![CDATA[ <InstallAspNet ClientScriptsOnly="True" /> ]]>
</code>
</example>
</member>
<member name="M:MSBuild.Community.Tasks.AspNet.InstallAspNet.GenerateFullPathToTool">
<summary>
Returns the fully qualified path to the executable file.
</summary>
<returns>
The fully qualified path to the executable file.
</returns>
</member>
<member name="M:MSBuild.Community.Tasks.AspNet.InstallAspNet.GenerateCommandLineCommands">
<summary>
Returns a string value containing the command line arguments
to pass directly to the executable file.
</summary>
<returns>
A string value containing the command line arguments to pass
directly to the executable file.
</returns>
</member>
<member name="M:MSBuild.Community.Tasks.AspNet.InstallAspNet.Execute">
<summary>
When overridden in a derived class, executes the task.
</summary>
<returns>
True if the task successfully executed; otherwise, false.
</returns>
</member>
<member name="M:MSBuild.Community.Tasks.AspNet.InstallAspNet.IsValidPropertyCombinations">
<summary>
Determines if the current property values can be used together
</summary>
<returns><see langword="true"/> when properties can be used together.</returns>
<exclude />
</member>
<member name="P:MSBuild.Community.Tasks.AspNet.InstallAspNet.Version">
<summary>
The version of ASP.NET to install
</summary>
<remarks>
The default behavior is to use the latest version of ASP.NET available on the computer.
<list type="table">
<listheader><term>Version</term></listheader>
<item><term>Version11</term><description>ASP.NET v1.1</description></item>
<item><term>Version20</term><description>ASP.NET v2.0</description></item>
<item><term>VersionLatest</term><description>The latest version of ASP.NET available</description></item>
</list>
</remarks>
</member>
<member name="P:MSBuild.Community.Tasks.AspNet.InstallAspNet.ApplyScriptMaps">
<summary>
The method used to determine if ASP.NET script mappings should be applied
</summary>
<remarks>
The default behavior is to register script mappings on all sites except those with a newer version of ASP.NET.
<list type="table">
<listheader><term>Value</term></listheader>
<item><term>Never</term><description>Register ASP.NET on the computer without updating any script mappings.</description></item>
<item><term>IfNoneExist</term><description>Register script mappings only on for sites that do not have any existing ASP.NET script mappings (not available for ASP.NET v1.1)</description></item>
<item><term>UnlessNewerExist</term><description>Register script mappings on all sites except those with a newer version of ASP.NET.</description></item>
<item><term>Always</term><description>Register script mappings on all sites, even if they already have a newer version of ASP.NET.</description></item>
</list>
</remarks>
</member>
<member name="P:MSBuild.Community.Tasks.AspNet.InstallAspNet.ClientScriptsOnly">
<summary>
When <see langword="true"/>, the aspnet_client scripts will be installed. No script mappings will be updated.
</summary>
<remarks>This cannot be <see langword="true"/> if a value for <see cref="P:MSBuild.Community.Tasks.AspNet.InstallAspNet.Path"/> or <see cref="P:MSBuild.Community.Tasks.AspNet.InstallAspNet.ApplyScriptMaps"/> has been specified.</remarks>
</member>
<member name="P:MSBuild.Community.Tasks.AspNet.InstallAspNet.Path">
<summary>
The web application that should have its script maps updated.
</summary>
<remarks>
The path must be of the form W3SVC/[instance]/Root/[webdirectory], for example W3SVC/1/Root/SampleApp1.
As a shortcut, you can specify just the web directory name,
if the web directory is installed in the default website instance (W3SVC/1/Root).
<para>You should not specify a value for <see cref="P:MSBuild.Community.Tasks.AspNet.InstallAspNet.ApplyScriptMaps"/> when specifying a path.</para>
</remarks>
</member>
<member name="P:MSBuild.Community.Tasks.AspNet.InstallAspNet.Recursive">
<summary>
When <see langword="true"/>, script maps are applied recursively under <see cref="P:MSBuild.Community.Tasks.AspNet.InstallAspNet.Path"/>.
</summary>
<remarks>This property is only valid when specifying a value for <see cref="P:MSBuild.Community.Tasks.AspNet.InstallAspNet.Path"/>. It is <see langword="true"/> by default.</remarks>
</member>
<member name="P:MSBuild.Community.Tasks.AspNet.InstallAspNet.ToolName">
<summary>
Gets the name of the executable file to run.
</summary>
<value></value>
<returns>The name of the executable file to run.</returns>
</member>
<member name="T:MSBuild.Community.Tasks.AssemblyInfo">
<summary>
Generates an AssemblyInfo files
</summary>
<example>
<para>Generates a common version file.</para>
<code><![CDATA[
<AssemblyInfo CodeLanguage="CS"
OutputFile="VersionInfo.cs"
AssemblyVersion="1.0.0.0"
AssemblyFileVersion="1.0.0.0" />
]]></code>
<para>Generates a complete version file.</para>
<code><![CDATA[
<AssemblyInfo CodeLanguage="CS"
OutputFile="$(MSBuildProjectDirectory)\Test\GlobalInfo.cs"
AssemblyTitle="AssemblyInfoTask"
AssemblyDescription="AssemblyInfo Description"
AssemblyConfiguration=""
AssemblyCompany="Company Name, LLC"
AssemblyProduct="AssemblyInfoTask"
AssemblyCopyright="Copyright (c) Company Name, LLC 2006"
AssemblyTrademark=""
ComVisible="false"
CLSCompliant="true"
Guid="d038566a-1937-478a-b5c5-b79c4afb253d"
AssemblyVersion="1.0.0.0"
AssemblyFileVersion="1.0.0.0" />
]]></code>
<para>Generates a complete version file for C++/CLI.</para>
<code><![CDATA[
<AssemblyInfo CodeLanguage="CPP"
OutputFile="$(MSBuildProjectDirectory)\Properties\AssemblyInfo.cpp"
AssemblyTitle="MyAssembly"
AssemblyDescription="MyAssembly Description"
AssemblyConfiguration="$(Configuration)"
AssemblyCompany="Company Name, LLC"
AssemblyProduct="MyAssembly"
AssemblyCopyright="Copyright (c) Company Name, LLC 2008"
AssemblyTrademark=""
ComVisible="false"
CLSCompliant="true"
Guid="d038566a-1937-478a-b5c5-b79c4afb253d"
AssemblyVersion="1.0.0.0"
AssemblyFileVersion="1.0.0.0"
UnmanagedCode="true" />
]]></code>
</example>
</member>
<member name="F:MSBuild.Community.Tasks.AssemblyInfo.DEFAULT_OUTPUT_FILE">
<summary>
The default value of <see cref="P:MSBuild.Community.Tasks.AssemblyInfo.OutputFile"/>.
The value is <c>"AssemblyInfo.cs"</c>.
</summary>
</member>
<member name="M:MSBuild.Community.Tasks.AssemblyInfo.#ctor">
<summary>
Initializes a new instance of the <see cref="T:MSBuild.Community.Tasks.AssemblyInfo"/> class.
</summary>
</member>
<member name="M:MSBuild.Community.Tasks.AssemblyInfo.Execute">
<summary>
When overridden in a derived class, executes the task.
</summary>
<returns>
true if the task successfully executed; otherwise, false.
</returns>
</member>
<member name="P:MSBuild.Community.Tasks.AssemblyInfo.CodeLanguage">
<summary>
Gets or sets the code language.
</summary>
<value>The code language.</value>
</member>
<member name="P:MSBuild.Community.Tasks.AssemblyInfo.ComVisible">
<summary>
Gets or sets a value indicating whether [COMVisible].
</summary>
<value><c>true</c> if [COMVisible]; otherwise, <c>false</c>.</value>
</member>
<member name="P:MSBuild.Community.Tasks.AssemblyInfo.CLSCompliant">
<summary>
Gets or sets a value indicating whether [CLSCompliant].
</summary>
<value><c>true</c> if [CLSCompliant]; otherwise, <c>false</c>.</value>
</member>
<member name="P:MSBuild.Community.Tasks.AssemblyInfo.Guid">
<summary>
Gets or sets the GUID.
</summary>
<value>The GUID.</value>
</member>
<member name="P:MSBuild.Community.Tasks.AssemblyInfo.AssemblyTitle">
<summary>
Gets or sets the assembly title.
</summary>
<value>The assembly title.</value>
</member>
<member name="P:MSBuild.Community.Tasks.AssemblyInfo.AssemblyDescription">
<summary>
Gets or sets the assembly description.
</summary>
<value>The assembly description.</value>
</member>
<member name="P:MSBuild.Community.Tasks.AssemblyInfo.AssemblyConfiguration">
<summary>
Gets or sets the assembly configuration.
</summary>
<value>The assembly configuration.</value>
</member>
<member name="P:MSBuild.Community.Tasks.AssemblyInfo.AssemblyCompany">
<summary>
Gets or sets the assembly company.
</summary>
<value>The assembly company.</value>
</member>
<member name="P:MSBuild.Community.Tasks.AssemblyInfo.AssemblyProduct">
<summary>
Gets or sets the assembly product.
</summary>
<value>The assembly product.</value>
</member>
<member name="P:MSBuild.Community.Tasks.AssemblyInfo.AssemblyCopyright">
<summary>
Gets or sets the assembly copyright.
</summary>
<value>The assembly copyright.</value>
</member>
<member name="P:MSBuild.Community.Tasks.AssemblyInfo.AssemblyTrademark">
<summary>
Gets or sets the assembly trademark.
</summary>
<value>The assembly trademark.</value>
</member>
<member name="P:MSBuild.Community.Tasks.AssemblyInfo.AssemblyCulture">
<summary>
Gets or sets the assembly culture.
</summary>
<value>The assembly culture.</value>
</member>
<member name="P:MSBuild.Community.Tasks.AssemblyInfo.AssemblyVersion">
<summary>
Gets or sets the assembly version.
</summary>
<value>The assembly version.</value>
</member>
<member name="P:MSBuild.Community.Tasks.AssemblyInfo.AssemblyFileVersion">
<summary>
Gets or sets the assembly file version.
</summary>
<value>The assembly file version.</value>
</member>
<member name="P:MSBuild.Community.Tasks.AssemblyInfo.AssemblyInformationalVersion">
<summary>
Gets or sets the assembly informational version.
</summary>
<value>The assembly informational version.</value>
</member>
<member name="P:MSBuild.Community.Tasks.AssemblyInfo.AssemblyKeyFile">
<summary>
Gets or sets the assembly key file.
</summary>
</member>
<member name="P:MSBuild.Community.Tasks.AssemblyInfo.AssemblyKeyName">
<summary>
Gets or sets the assembly key name.
</summary>
</member>
<member name="P:MSBuild.Community.Tasks.AssemblyInfo.AssemblyDelaySign">
<summary>
Gets or sets the assembly delay sign value.
</summary>
</member>
<member name="P:MSBuild.Community.Tasks.AssemblyInfo.SkipVerification">
<summary>
Gets or sets the assembly delay sign value.
</summary>
</member>
<member name="P:MSBuild.Community.Tasks.AssemblyInfo.UnmanagedCode">
<summary>
Gets or sets the assembly delay sign value.
</summary>
</member>
<member name="P:MSBuild.Community.Tasks.AssemblyInfo.GenerateClass">
<summary>
Gets or sets a value indicating whether to generate the ThisAssmebly class.
</summary>
</member>
<member name="P:MSBuild.Community.Tasks.AssemblyInfo.NeutralResourcesLanguage">
<summary>
Gets or sets the neutral language which is used as a fallback language configuration
if the locale on the computer isn't supported. Example is setting this to "en-US".
</summary>
</member>
<member name="P:MSBuild.Community.Tasks.AssemblyInfo.UltimateResourceFallbackLocation">
<summary>
Gets or sets the ultimate resource fallback location.
</summary>
<value>The ultimate resource fallback location.</value>
</member>
<member name="P:MSBuild.Community.Tasks.AssemblyInfo.InternalsVisibleTo">
<summary>
Makes it possible to make certain assemblies able to use constructs marked as internal.
Example might be setting this value to "UnitTests" assembly. The typical use case might
be constructors in classes which shouldn't be available to other assemblies, but the unit
tests should be able to use them.
</summary>
</member>
<member name="P:MSBuild.Community.Tasks.AssemblyInfo.AllowPartiallyTrustedCallers">
<summary>
Gets or sets whether to allow strong-named assemblies to be called by partially trusted code.
</summary>
</member>
<member name="P:MSBuild.Community.Tasks.AssemblyInfo.OutputFile">
<summary>
Gets or sets the output file.
</summary>
<value>The output file.</value>
</member>
<member name="T:MSBuild.Community.Tasks.Attrib">
<summary>
Changes the attributes of files and/or directories
</summary>
<example>
<para>Make file Readonly, Hidden and System.</para>
<code><![CDATA[
<Attrib Files="Test\version.txt"
ReadOnly="true" Hidden="true" System="true"/>
]]></code>
<para>Clear Hidden and System attributes.</para>
<code><![CDATA[
<Attrib Files="Test\version.txt"
Hidden="false" System="false"/>
]]></code>
<para>Make file Normal.</para>
<code><![CDATA[
<Attrib Files="Test\version.txt"
Normal="true"/>
]]></code>
</example>
</member>
<member name="M:MSBuild.Community.Tasks.Attrib.Execute">
<summary>
Executes the task.
</summary>
<returns><see langword="true"/> if the task ran successfully;
otherwise <see langword="false"/>.</returns>
</member>
<member name="P:MSBuild.Community.Tasks.Attrib.Files">
<summary>
Gets or sets the list of files to change attributes on.
</summary>
<value>The files to change attributes on.</value>
</member>
<member name="P:MSBuild.Community.Tasks.Attrib.Directories">
<summary>
Gets or sets the list of directories to change attributes on.
</summary>
<value>The directories to change attributes on.</value>
</member>
<member name="P:MSBuild.Community.Tasks.Attrib.Archive">
<summary>
Gets or sets file's archive status.
</summary>
<value><c>true</c> if archive; otherwise, <c>false</c>.</value>
</member>
<member name="P:MSBuild.Community.Tasks.Attrib.Compressed">
<summary>
Gets or sets a value indicating file is compressed.
</summary>
<value><c>true</c> if compressed; otherwise, <c>false</c>.</value>
</member>
<member name="P:MSBuild.Community.Tasks.Attrib.Encrypted">
<summary>
Gets or sets a value indicating file is encrypted.
</summary>
<value><c>true</c> if encrypted; otherwise, <c>false</c>.</value>
</member>
<member name="P:MSBuild.Community.Tasks.Attrib.Hidden">
<summary>
Gets or sets a value indicating file is hidden, and thus is not included in an ordinary directory listing.
</summary>
<value><c>true</c> if hidden; otherwise, <c>false</c>.</value>
</member>
<member name="P:MSBuild.Community.Tasks.Attrib.Normal">
<summary>
Gets or sets a value indicating file is normal and has no other attributes set.
</summary>
<value><c>true</c> if normal; otherwise, <c>false</c>.</value>
</member>
<member name="P:MSBuild.Community.Tasks.Attrib.ReadOnly">
<summary>
Gets or sets a value indicating file is read-only.
</summary>
<value><c>true</c> if read-only; otherwise, <c>false</c>.</value>
</member>
<member name="P:MSBuild.Community.Tasks.Attrib.System">
<summary>
Gets or sets a value indicating file is a system file.
</summary>
<value><c>true</c> if system; otherwise, <c>false</c>.</value>
</member>
<member name="T:MSBuild.Community.Tasks.ByteDescriptions">
<summary>
Describes certain byte measurements as nice strings.
</summary>
</member>
<member name="T:MSBuild.Community.Tasks.Computer">
<summary>
Provides information about the build computer.
</summary>
<example>Get build computer information.
<code><![CDATA[
<Computer>
<Output TaskParameter="Name" PropertyName="BuildMachineName" />
<Output TaskParameter="IPAddress" PropertyName="BuildMachineIPAddress" />
<Output TaskParameter="OSPlatform" PropertyName="BuildMachineOSPlatform" />
<Output TaskParameter="OSVersion" PropertyName="BuildMachineOSVersion" />
</Computer>
]]></code>
</example>
</member>
<member name="M:MSBuild.Community.Tasks.Computer.#ctor">
<summary>
Initializes a new instance of the <see cref="T:Computer"/> class.
</summary>
</member>
<member name="M:MSBuild.Community.Tasks.Computer.Execute">
<summary>
Executes the task.
</summary>
<returns>
<see langword="true"/> if the task ran successfully; otherwise <see langword="false"/>.
</returns>
</member>
<member name="P:MSBuild.Community.Tasks.Computer.Name">
<summary>
Gets the host name of the build computer.
</summary>
</member>
<member name="P:MSBuild.Community.Tasks.Computer.IPAddress">
<summary>
Gets the IP address of the build computer.
</summary>
</member>
<member name="P:MSBuild.Community.Tasks.Computer.OSPlatform">
<summary>
Gets the platform identifier of the build computer's operating system .
</summary>
</member>
<member name="P:MSBuild.Community.Tasks.Computer.OSVersion">
<summary>
Gets the version number of the build computer's operating system.
</summary>
</member>
<member name="T:MSBuild.Community.Tasks.Beep">
<summary>
A task to play the sound of a beep through the console speaker.
</summary>
<remarks>
By default, the beep plays at a frequency of 800 hertz for a duration of 200 milliseconds.
</remarks><example>
To play the sound of a beep at a frequency of 800 hertz and for a duration of 200 milliseconds, use
<code>
<![CDATA[<Beep />]]>
</code>
</example><example>
To play the sound of a beep at a frequency of 440 hertz and for a duration of 300 milliseconds, use
<code>
<![CDATA[<Beep Frequency="440" Duration="300" />]]>
</code>
</example>
</member>
<member name="M:MSBuild.Community.Tasks.Beep.Execute">
<summary>
Plays the sound of a beep
at the given <see cref="P:MSBuild.Community.Tasks.Beep.Frequency"/> and for the given <see cref="P:MSBuild.Community.Tasks.Beep.Duration"/>
through the console speaker.
</summary>
<returns>
Always returns <see langword="true"/>, even when the sound could not be played.
</returns>
</member>
<member name="P:MSBuild.Community.Tasks.Beep.Frequency">
<summary>
Gets or sets the frequency of the beep, ranging from 37 to 32767 hertz.
Defaults to 800 hertz.
</summary>
</member>
<member name="P:MSBuild.Community.Tasks.Beep.Duration">
<summary>
Gets or sets the of the beep measured in milliseconds.
Defaults to 200 milliseconds.
</summary>
</member>
<member name="T:MSBuild.Community.Tasks.DeleteTree">
<summary>
Delete a directory tree. This task supports wild card directory selection.
</summary>
<example>
<para>Delete all bin and obj directories.</para>
<code><![CDATA[
<DeleteTree Directories="**\bin;**\obj" />
]]></code>
<para>Delete all bin and obj directories that start with MSBuild.Community.</para>
<code><![CDATA[
<DeleteTree Directories="MSBuild.Community.*\**\bin;MSBuild.Community.*\**\obj" />
]]></code>
</example>
</member>
<member name="M:MSBuild.Community.Tasks.DeleteTree.#ctor">
<summary>
Initializes a new instance of the <see cref="T:MSBuild.Community.Tasks.DeleteTree"/> class.
</summary>
</member>
<member name="M:MSBuild.Community.Tasks.DeleteTree.Execute">
<summary>
When overridden in a derived class, executes the task.
</summary>
<returns>
true if the task successfully executed; otherwise, false.
</returns>
</member>
<member name="P:MSBuild.Community.Tasks.DeleteTree.Directories">
<summary>
Gets or sets the directories to be deleted.
</summary>
<value>The directories to be deleted.</value>
<remarks>
Directories can contain wild cards.
</remarks>
</member>
<member name="P:MSBuild.Community.Tasks.DeleteTree.Recursive">
<summary>
Gets or sets a value indicating whether this <see cref="T:MSBuild.Community.Tasks.DeleteTree"/> is recursive.
</summary>
<value><c>true</c> if recursive; otherwise, <c>false</c>.</value>
</member>
<member name="P:MSBuild.Community.Tasks.DeleteTree.DeletedDirectories">
<summary>
Gets the deleted directories.
</summary>
<value>The deleted directories.</value>
</member>
<member name="T:MSBuild.Community.Tasks.FtpUpload">
<summary>
Uploads a group of files using File Transfer Protocol (FTP).
</summary>
<remarks>
Set either LocalFiles or LocalFile but not both.
</remarks>
<example>Upload a file.
<code><![CDATA[
<FtpUpload
LocalFile="MSBuild.Community.Tasks.zip"
RemoteUri="ftp://localhost/" />
]]></code>
Upload all the files in an ItemGroup:
<code><![CDATA[
<FtpUpload
Username="username"
Password="password"
UsePassive="true"
RemoteUri="ftp://webserver.com/httpdocs/"
LocalFiles="@(FilesToUpload)"
RemoteFiles="@(FilesToUpload->'%(RecursiveDir)%(Filename)%(Extension)')" />
]]></code>
</example>
</member>
<member name="T:MSBuild.Community.Tasks.IFtpWebRequestCreator">
<summary>
Describes a factory for IFtpWebRequest.
</summary>
</member>
<member name="M:MSBuild.Community.Tasks.IFtpWebRequestCreator.Create(System.Uri,System.String)">
<summary>
Instantiates an FtpWebRequest.
</summary>
</member>
<member name="M:MSBuild.Community.Tasks.FtpUpload.#ctor">
<summary>
Initializes a new instance of the <see cref="T:FtpUpload"/> class.
</summary>
</member>
<member name="M:MSBuild.Community.Tasks.FtpUpload.#ctor(MSBuild.Community.Tasks.IFtpWebRequestCreator)">
<summary>
Initializes a new instance that will inject the specified dependency.
</summary>
<param name="requestCreator"></param>
</member>
<member name="M:MSBuild.Community.Tasks.FtpUpload.Execute">
<summary>
When overridden in a derived class, executes the task.
</summary>
<returns>
true if the task successfully executed; otherwise, false.
</returns>
</member>
<member name="P:MSBuild.Community.Tasks.FtpUpload.LocalFile">
<summary>
Gets or sets the single file to upload. Use
this or LocalFiles, but not both.
</summary>
</member>
<member name="P:MSBuild.Community.Tasks.FtpUpload.LocalFiles">
<summary>
Gets or sets the local files to upload. Use this
or LocalFile, but not both.
</summary>
<value>The local file.</value>
</member>
<member name="P:MSBuild.Community.Tasks.FtpUpload.RemoteFiles">
<summary>
Gets or sets the remote files to upload.
Each item in this list should have a corresponding item in LocalFiles.
</summary>
</member>
<member name="P:MSBuild.Community.Tasks.FtpUpload.RemoteUri">
<summary>
Gets or sets the remote URI to upload.
</summary>
<value>The remote URI.</value>
</member>
<member name="P:MSBuild.Community.Tasks.FtpUpload.Username">
<summary>
Gets or sets the username.
</summary>
<value>The username.</value>
</member>
<member name="P:MSBuild.Community.Tasks.FtpUpload.Password">
<summary>
Gets or sets the password.
</summary>
<value>The password.</value>
</member>
<member name="P:MSBuild.Community.Tasks.FtpUpload.UsePassive">
<summary>
Gets or sets the behavior of a client application's data transfer process.
</summary>
<value><c>true</c> if [use passive]; otherwise, <c>false</c>.</value>
</member>
<member name="T:MSBuild.Community.Tasks.IFtpWebRequest">
<summary>
This class references an interface that looks like FtpWebRequest
in order to support unit testing without an actual FTP Server.
</summary>
</member>
<member name="M:MSBuild.Community.Tasks.IFtpWebRequest.SetContentLength(System.Int64)">
<summary>
Sets the ContentLength property of the FtpWebRequest.
</summary>
<param name="length"></param>
</member>
<member name="M:MSBuild.Community.Tasks.IFtpWebRequest.GetRequestStream">
<summary>
Calls GetRequestStream on the FtpWebRequest.
</summary>
<returns></returns>
</member>
<member name="M:MSBuild.Community.Tasks.IFtpWebRequest.GetStatusDescriptionAndCloseResponse">
<summary>
Gets the StatusDescription property of the response, then closes the response
on the FtpWebRequest.
</summary>
<returns></returns>
</member>
<member name="M:MSBuild.Community.Tasks.IFtpWebRequest.GetAndCloseResponse">
<summary>
Gets the response from the FTP server and closes it.
</summary>
</member>
<member name="M:MSBuild.Community.Tasks.IFtpWebRequest.GetResponseStream">
<summary>
Gets the response stream from the FtpWebRequest.
</summary>
<returns></returns>
</member>
<member name="T:MSBuild.Community.Tasks.RealFtpWebRequest">
<summary>
An adapter to make the real FtpWebRequest look like
an IFtpWebRequest.
</summary>
</member>
<member name="M:MSBuild.Community.Tasks.RealFtpWebRequest.#ctor(System.Net.FtpWebRequest)">
<summary>
Initializes a new instance of the RealFtpWebRequest class.
</summary>
</member>
<member name="T:MSBuild.Community.Tasks.Ftp.FtpClientTaskBase">
<summary>
Ftp client base class.
</summary>
</member>
<member name="F:MSBuild.Community.Tasks.Ftp.FtpClientTaskBase._clientSocket">
<summary>
The socket that will connect to the FTP server.
</summary>
</member>
<member name="F:MSBuild.Community.Tasks.Ftp.FtpClientTaskBase._bufferSize">
<summary>
The size of the data buffer.
</summary>
</member>
<member name="F:MSBuild.Community.Tasks.Ftp.FtpClientTaskBase._lastReply">
<summary>
The last recieved FTP response over the client socket.
</summary>
</member>
<member name="F:MSBuild.Community.Tasks.Ftp.FtpClientTaskBase._password">
<summary>
The password to use to login.
</summary>
</member>
<member name="F:MSBuild.Community.Tasks.Ftp.FtpClientTaskBase._port">
<summary>
The port number of the FTP server.
</summary>
</member>
<member name="F:MSBuild.Community.Tasks.Ftp.FtpClientTaskBase._serverhost">
<summary>
The hostname of the FTP server.
</summary>
</member>
<member name="F:MSBuild.Community.Tasks.Ftp.FtpClientTaskBase._username">
<summary>
The username to use to login.
</summary>
</member>
<member name="M:MSBuild.Community.Tasks.Ftp.FtpClientTaskBase.#ctor">
<summary>
Initializes a new instance of the <see cref="T:MSBuild.Community.Tasks.Ftp.FtpClientTaskBase"/> class.
</summary>
</member>
<member name="M:MSBuild.Community.Tasks.Ftp.FtpClientTaskBase.Connect">
<summary>
Connects this FTP server socket.
</summary>
<exception cref="T:MSBuild.Community.Tasks.Ftp.FtpException">Thrown when unable to connect.</exception>
</member>
<member name="M:MSBuild.Community.Tasks.Ftp.FtpClientTaskBase.Login">
<summary>
Login to the FTP server with the specified credentials.
</summary>
</member>
<member name="M:MSBuild.Community.Tasks.Ftp.FtpClientTaskBase.ChangeWorkingDirectory(System.String)">
<summary>
Changes the working directory.
</summary>
<param name="remoteDirectory">The remote directory.</param>
<exception cref="T:MSBuild.Community.Tasks.Ftp.FtpException">Occurs if there where connection problems during the process or the FTP server doesn't support the CWD command. See the Message of the exception for details.</exception>
<remarks>Sends the CWD command.</remarks>
</member>
<member name="M:MSBuild.Community.Tasks.Ftp.FtpClientTaskBase.GetWorkingDirectory">
<summary>
Gets the working directory.
</summary>
<returns>The current working directory.</returns>
</member>
<member name="M:MSBuild.Community.Tasks.Ftp.FtpClientTaskBase.CdUp">
<summary>
Change to the parent of the current working directory.
</summary>
<exception cref="T:MSBuild.Community.Tasks.Ftp.FtpException">Occurs if there where connection problems during the process or the FTP server doesn't support the CDUP command. See the Message of the exception for details.</exception>
<remarks>Sends the CDUP command.</remarks>
</member>
<member name="M:MSBuild.Community.Tasks.Ftp.FtpClientTaskBase.FileExists(System.String)">
<summary>
Determs whether a remote file exists.
</summary>
<param name="remoteFile">The remote file.</param>
<returns></returns>
<exception cref="T:MSBuild.Community.Tasks.Ftp.FtpException">Occurs if there where connection problems during the operation or if the FTP server doesn't support the SIZE command. See the Message of the exception for details.</exception>
</member>
<member name="M:MSBuild.Community.Tasks.Ftp.FtpClientTaskBase.DirectoryExists(System.String)">
<summary>
Determs whether a remote directory exists.
</summary>
<param name="remoteDirectory">The remote directory.</param>
<remarks>
This method is based on the succeedness of a CWD command, this can give wrong indication at a rare number of FTP server!
</remarks>
<exception cref="T:MSBuild.Community.Tasks.Ftp.FtpException">Thrown if the opperation couldn't be executed.</exception>
<returns><c>true</c> if the directory exists remotely; otherwise <c>false</c></returns>
</member>
<member name="M:MSBuild.Community.Tasks.Ftp.FtpClientTaskBase.RemoveDirectory(System.String)">
<summary>
Removes a remote directory.
</summary>
<param name="directoryName">The remote directory name.</param>
<exception cref="T:MSBuild.Community.Tasks.Ftp.FtpException">Occurs if there where connection problems during the process or the FTP server doesn't support the RMD command. See the Message of the exception for details.</exception>
<remarks>Sends the RMD command.</remarks>
</member>
<member name="M:MSBuild.Community.Tasks.Ftp.FtpClientTaskBase.MakeDirectory(System.String)">
<summary>
Creates a remote directory in the current working folder.
</summary>
<param name="directoryName">Name of the directory.</param>
<exception cref="T:MSBuild.Community.Tasks.Ftp.FtpException">Occurs if there where connection problems during the process or the FTP server doesn't support the MMD command. See the Message of the exception for details.</exception>
</member>
<member name="M:MSBuild.Community.Tasks.Ftp.FtpClientTaskBase.Close">
<summary>
Closes the connection to the server.
</summary>
</member>
<member name="M:MSBuild.Community.Tasks.Ftp.FtpClientTaskBase.Store(System.String,System.String)">
<summary>
Stores the specified localFile.
</summary>
<param name="localFile">The localfile.</param>
<param name="remoteFileName">The remotefile.</param>
</member>
<member name="M:MSBuild.Community.Tasks.Ftp.FtpClientTaskBase.SendCommand(System.String,System.String)">
<summary>
Send a command to the FTP server.
</summary>
<param name="command">The command, for example PWD.</param>
<param name="value">The value.</param>
</member>
<member name="M:MSBuild.Community.Tasks.Ftp.FtpClientTaskBase.SendCommand(System.String)">
<summary>
Send a command to the FTP server.
</summary>
<param name="rawCommand">The full command to send.</param>
</member>
<member name="M:MSBuild.Community.Tasks.Ftp.FtpClientTaskBase.SendCommandAndReadResponse(System.String,System.String)">
<summary>
Send a command to the FTP server and returns the response.
</summary>
<param name="command">The command, for example PWD.</param>
<param name="value">The value</param>
<returns>The reply of the FTP server for this command.</returns>
</member>
<member name="M:MSBuild.Community.Tasks.Ftp.FtpClientTaskBase.SendCommandAndReadResponse(System.String)">
<summary>
Send a command to the FTP server and returns the response.
</summary>
<param name="rawCommand">The raw command to send.</param>
<returns>The reply of the FTP server for this command.</returns>
</member>
<member name="M:MSBuild.Community.Tasks.Ftp.FtpClientTaskBase.GetDirectoryDetails">
<summary>
Get the full directory details of the current directory.
</summary>
<returns>A array that contains all the FTP files located in the currenct directory.</returns>
</member>
<member name="M:MSBuild.Community.Tasks.Ftp.FtpClientTaskBase.CreateDataStreamAndSendCommand(System.String)">
<summary>
Create a data stream and send a raw command.
</summary>
<param name="rawCommand">The raw command to send.</param>
<returns>The data stream that was created.</returns>
</member>
<member name="M:MSBuild.Community.Tasks.Ftp.FtpClientTaskBase.ParseDataEndPointFromMessage(System.String)">
<summary>
Parses the data IP end point from datarequest message.
</summary>
<param name="message">The message.</param>
<returns></returns>
</member>
<member name="M:MSBuild.Community.Tasks.Ftp.FtpClientTaskBase.GetDirectoryDetails(System.String)">
<summary>
Get the full directory details of the current directory.
</summary>
<param name="remoteDirectory">The remove directory, emtpy or <c>null</c> will get the details of the current directory.</param>
<returns>A array that contains all the FTP files located in the currenct directory.</returns>
</member>
<member name="M:MSBuild.Community.Tasks.Ftp.FtpClientTaskBase.ReadResponse">
<summary>
Reads the ftp response from the client socket.
</summary>
<returns>The response of the FTP server.</returns>
</member>
<member name="M:MSBuild.Community.Tasks.Ftp.FtpClientTaskBase.ReadResponseString">
<summary>
Reads the response string from the client socket.
</summary>
<returns>The response of the client socket.</returns>
</member>
<member name="M:MSBuild.Community.Tasks.Ftp.FtpClientTaskBase.CloseAndTrowException(System.Exception)">
<summary>
Make sure the connections are closed and trow the specified exception.
</summary>
<param name="exception">The exception to throw.</param>
</member>
<member name="P:MSBuild.Community.Tasks.Ftp.FtpClientTaskBase.ServerHost">
<summary>
Gets or sets the server host.
</summary>
<value>The server host.</value>
<exception cref="T:System.ArgumentOutOfRangeException">The lenght of the given value is greater then 126 characters.</exception>
</member>
<member name="P:MSBuild.Community.Tasks.Ftp.FtpClientTaskBase.Port">
<summary>
Gets or sets the port number.
</summary>
<value>The port numer.</value>
</member>
<member name="P:MSBuild.Community.Tasks.Ftp.FtpClientTaskBase.ClientSocket">
<summary>
Gets or sets the client socket.
</summary>
<value>The client socket.</value>
</member>
<member name="P:MSBuild.Community.Tasks.Ftp.FtpClientTaskBase.Connected">
<summary>
Gets a value indicating whether this <see cref="T:MSBuild.Community.Tasks.Ftp.FtpClientTaskBase"/> is connected.
</summary>
<value><c>true</c> if connected; otherwise, <c>false</c>.</value>
</member>
<member name="P:MSBuild.Community.Tasks.Ftp.FtpClientTaskBase.ConversationEncoding">
<summary>
Gets the encoding to use with communication with the server.
</summary>
<value>The encoding.</value>
</member>
<member name="P:MSBuild.Community.Tasks.Ftp.FtpClientTaskBase.LastReply">
<summary>
Gets the last recieved FTP response over the client socket.
</summary>
<value>The last recieved FTP response over the client socket.</value>
</member>
<member name="P:MSBuild.Community.Tasks.Ftp.FtpClientTaskBase.Username">
<summary>
Gets or sets the username to login.
</summary>
<value>The username.</value>
</member>
<member name="P:MSBuild.Community.Tasks.Ftp.FtpClientTaskBase.Password">
<summary>
Gets or sets the password to login.
</summary>
<value>The password.</value>
</member>
<member name="P:MSBuild.Community.Tasks.Ftp.FtpClientTaskBase.LogFtpMessageConversation">
<summary>
Gets or sets a value indicating whether the FTP message conversation should be logged.
</summary>
<value>
<c>true</c> if the FTP message conversation should be logged; otherwise, <c>false</c>.
</value>
</member>
<member name="P:MSBuild.Community.Tasks.Ftp.FtpClientTaskBase.BufferSize">
<summary>
Gets or sets the size of the data buffer.
</summary>
</member>
<member name="T:MSBuild.Community.Tasks.Ftp.FtpCreateRemoteDirectory">
<summary>
Creates a full remote directory on the remote server if not exists using the File Transfer Protocol (FTP).
This can be one directory or a full path to create.
</summary>
<example>Create remote directory:
<code><![CDATA[
<FtpCreateRemoteDirectoty
ServerHost="ftp.myserver.com"
Port="42"
RemoteDirectory="Directory\Subdirectory\MyOtherSubdirectory"
Username="user"
Password="p@ssw0rd"
/>
]]></code>
</example>
<remarks>The full remote directory path will be created. All directories that doesn't exists on the remote server will be created.</remarks>
</member>
<member name="F:MSBuild.Community.Tasks.Ftp.FtpCreateRemoteDirectory._remoteDirectory">
<summary>
The remote directory to create.
</summary>
</member>