Repository navigation
Expand file tree
/
Copy pathToolTask.xml
More file actions
1175 lines (1122 loc) · 67.6 KB
/
Copy pathToolTask.xml
File metadata and controls
1175 lines (1122 loc) · 67.6 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
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
<Type Name="ToolTask" FullName="Microsoft.Build.Utilities.ToolTask">
<TypeSignature Language="C#" Value="public abstract class ToolTask : Microsoft.Build.Utilities.Task, Microsoft.Build.Framework.ICancelableTask" />
<TypeSignature Language="ILAsm" Value=".class public auto ansi abstract beforefieldinit ToolTask extends Microsoft.Build.Utilities.Task implements class Microsoft.Build.Framework.ICancelableTask, class Microsoft.Build.Framework.ITask" />
<TypeSignature Language="DocId" Value="T:Microsoft.Build.Utilities.ToolTask" />
<TypeSignature Language="VB.NET" Value="Public MustInherit Class ToolTask
Inherits Task
Implements ICancelableTask" />
<TypeSignature Language="C++ CLI" Value="public ref class ToolTask abstract : Microsoft::Build::Utilities::Task, Microsoft::Build::Framework::ICancelableTask" />
<AssemblyInfo>
<AssemblyName>Microsoft.Build.Utilities.v4.0</AssemblyName>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Base>
<BaseTypeName>Microsoft.Build.Utilities.Task</BaseTypeName>
</Base>
<Interfaces>
<Interface>
<InterfaceName>Microsoft.Build.Framework.ICancelableTask</InterfaceName>
</Interface>
</Interfaces>
<Docs>
<summary>When overridden in a derived form, provides functionality for a task that wraps a command line tool.</summary>
<remarks>
<format type="text/markdown"><. The <xref:Microsoft.Build.Utilities.CommandLineBuilder>, <xref:Microsoft.Build.Utilities.ToolLocationHelper>, and <xref:Microsoft.Build.Utilities.TaskLoggingHelper> classes are used to generate the information needed to run the task.
[!code-csharp[msbuild_ToolTask#1](~/samples/snippets/csharp/VS_Snippets_Misc/msbuild_ToolTask/CS/ILAsm.cs#1)]
[!code-vb[msbuild_ToolTask#1](~/samples/snippets/visualbasic/VS_Snippets_Misc/msbuild_ToolTask/VB/ILAsm.vb#1)]
]]></format>
</remarks>
</Docs>
<Members>
<MemberGroup MemberName=".ctor">
<AssemblyInfo>
<AssemblyName>Microsoft.Build.Utilities.v4.0</AssemblyName>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Docs>
<summary>Initializes a new instance of the <see cref="T:Microsoft.Build.Utilities.ToolTask" /> class.</summary>
</Docs>
</MemberGroup>
<Member MemberName=".ctor">
<MemberSignature Language="C#" Value="protected ToolTask ();" />
<MemberSignature Language="ILAsm" Value=".method familyhidebysig specialname rtspecialname instance void .ctor() cil managed" />
<MemberSignature Language="DocId" Value="M:Microsoft.Build.Utilities.ToolTask.#ctor" />
<MemberSignature Language="VB.NET" Value="Protected Sub New ()" />
<MemberSignature Language="C++ CLI" Value="protected:
 ToolTask();" />
<MemberType>Constructor</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Build.Utilities.v4.0</AssemblyName>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Parameters />
<Docs>
<summary>Initializes a new instance of the <see cref="T:Microsoft.Build.Utilities.ToolTask" /> class.</summary>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName=".ctor">
<MemberSignature Language="C#" Value="protected ToolTask (System.Resources.ResourceManager taskResources);" />
<MemberSignature Language="ILAsm" Value=".method familyhidebysig specialname rtspecialname instance void .ctor(class System.Resources.ResourceManager taskResources) cil managed" />
<MemberSignature Language="DocId" Value="M:Microsoft.Build.Utilities.ToolTask.#ctor(System.Resources.ResourceManager)" />
<MemberSignature Language="VB.NET" Value="Protected Sub New (taskResources As ResourceManager)" />
<MemberSignature Language="C++ CLI" Value="protected:
 ToolTask(System::Resources::ResourceManager ^ taskResources);" />
<MemberType>Constructor</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Build.Utilities.v4.0</AssemblyName>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Parameters>
<Parameter Name="taskResources" Type="System.Resources.ResourceManager" />
</Parameters>
<Docs>
<param name="taskResources">The <see cref="T:System.Resources.ResourceManager" /> for task resources.</param>
<summary>Initializes a new instance of the <see cref="T:Microsoft.Build.Utilities.ToolTask" /> class with the specified <see cref="T:System.Resources.ResourceManager" />.</summary>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName=".ctor">
<MemberSignature Language="C#" Value="protected ToolTask (System.Resources.ResourceManager taskResources, string helpKeywordPrefix);" />
<MemberSignature Language="ILAsm" Value=".method familyhidebysig specialname rtspecialname instance void .ctor(class System.Resources.ResourceManager taskResources, string helpKeywordPrefix) cil managed" />
<MemberSignature Language="DocId" Value="M:Microsoft.Build.Utilities.ToolTask.#ctor(System.Resources.ResourceManager,System.String)" />
<MemberSignature Language="VB.NET" Value="Protected Sub New (taskResources As ResourceManager, helpKeywordPrefix As String)" />
<MemberSignature Language="C++ CLI" Value="protected:
 ToolTask(System::Resources::ResourceManager ^ taskResources, System::String ^ helpKeywordPrefix);" />
<MemberType>Constructor</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Build.Utilities.v4.0</AssemblyName>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Parameters>
<Parameter Name="taskResources" Type="System.Resources.ResourceManager" />
<Parameter Name="helpKeywordPrefix" Type="System.String" />
</Parameters>
<Docs>
<param name="taskResources">The <see cref="T:System.Resources.ResourceManager" /> for task resources.</param>
<param name="helpKeywordPrefix">The Help keyword to use for messages raised by the task.</param>
<summary>Initializes a new instance of the <see cref="T:Microsoft.Build.Utilities.ToolTask" /> class with the specified <see cref="T:System.Resources.ResourceManager" /> and Help keyword prefix.</summary>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="CallHostObjectToExecute">
<MemberSignature Language="C#" Value="protected virtual bool CallHostObjectToExecute ();" />
<MemberSignature Language="ILAsm" Value=".method familyhidebysig newslot virtual instance bool CallHostObjectToExecute() cil managed" />
<MemberSignature Language="DocId" Value="M:Microsoft.Build.Utilities.ToolTask.CallHostObjectToExecute" />
<MemberSignature Language="VB.NET" Value="Protected Overridable Function CallHostObjectToExecute () As Boolean" />
<MemberSignature Language="C++ CLI" Value="protected:
 virtual bool CallHostObjectToExecute();" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Build.Utilities.v4.0</AssemblyName>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Boolean</ReturnType>
</ReturnValue>
<Parameters />
<Docs>
<summary>Calls the host object to perform the work of the task.</summary>
<returns>
<see langword="true" /> if the method was successfule; otherwise, <see langword="false" />.</returns>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="Cancel">
<MemberSignature Language="C#" Value="public virtual void Cancel ();" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance void Cancel() cil managed" />
<MemberSignature Language="DocId" Value="M:Microsoft.Build.Utilities.ToolTask.Cancel" />
<MemberSignature Language="VB.NET" Value="Public Overridable 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.Utilities.v4.0</AssemblyName>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Void</ReturnType>
</ReturnValue>
<Parameters />
<Docs>
<summary>Cancels the process executing the task by asking it to close nicely, then after a short period, forcing termination.</summary>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="DeleteTempFile">
<MemberSignature Language="C#" Value="protected void DeleteTempFile (string fileName);" />
<MemberSignature Language="ILAsm" Value=".method familyhidebysig instance void DeleteTempFile(string fileName) cil managed" />
<MemberSignature Language="DocId" Value="M:Microsoft.Build.Utilities.ToolTask.DeleteTempFile(System.String)" />
<MemberSignature Language="VB.NET" Value="Protected Sub DeleteTempFile (fileName As String)" />
<MemberSignature Language="C++ CLI" Value="protected:
 void DeleteTempFile(System::String ^ fileName);" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Build.Utilities.v4.0</AssemblyName>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Void</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="fileName" Type="System.String" />
</Parameters>
<Docs>
<param name="fileName">The name of the temporary file to delete.</param>
<summary>Deletes the specified temporary file.</summary>
<remarks>
<format type="text/markdown"><![CDATA[
## Remarks
If the delete operation fails for any reason (such as if a file is locked by antivirus software), then this method logs a warning rather than throwing an exception, which would cause the build to fail.
]]></format>
</remarks>
</Docs>
</Member>
<Member MemberName="EchoOff">
<MemberSignature Language="C#" Value="public bool EchoOff { get; set; }" />
<MemberSignature Language="ILAsm" Value=".property instance bool EchoOff" />
<MemberSignature Language="DocId" Value="P:Microsoft.Build.Utilities.ToolTask.EchoOff" />
<MemberSignature Language="VB.NET" Value="Public Property EchoOff As Boolean" />
<MemberSignature Language="C++ CLI" Value="public:
 property bool EchoOff { bool get(); void set(bool value); };" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Build.Utilities.v4.0</AssemblyName>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Boolean</ReturnType>
</ReturnValue>
<Docs>
<summary>Indicates that command line echoing is turned off.</summary>
<value>True when command line echo is off.</value>
<remarks>
<format type="text/markdown"><![CDATA[
## Remarks
MSBuild turns off command line echoing by passing /Q on the cmd.exe command line.
]]></format>
</remarks>
</Docs>
</Member>
<Member MemberName="EnvironmentOverride">
<MemberSignature Language="C#" Value="protected virtual System.Collections.Specialized.StringDictionary EnvironmentOverride { get; }" />
<MemberSignature Language="ILAsm" Value=".property instance class System.Collections.Specialized.StringDictionary EnvironmentOverride" />
<MemberSignature Language="DocId" Value="P:Microsoft.Build.Utilities.ToolTask.EnvironmentOverride" />
<MemberSignature Language="VB.NET" Value="Protected Overridable ReadOnly Property EnvironmentOverride As StringDictionary" />
<MemberSignature Language="C++ CLI" Value="protected:
 virtual property System::Collections::Specialized::StringDictionary ^ EnvironmentOverride { System::Collections::Specialized::StringDictionary ^ get(); };" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Build.Utilities.v4.0</AssemblyName>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Attributes>
<Attribute>
<AttributeName>System.Obsolete("Use EnvironmentVariables property")</AttributeName>
</Attribute>
</Attributes>
<ReturnValue>
<ReturnType>System.Collections.Specialized.StringDictionary</ReturnType>
</ReturnValue>
<Docs>
<summary>Gets a set of environment variable name-value pairs. Designed to be overridden in a custom task class (derived from ToolTask) to return a set of new or altered environment variables to create the execution context of the associated tool.</summary>
<value>Returns a set of environment variables. Each dictionary key is the name of the environment variable to override and the dictionary value is the value to set for that environment variable. The default implementation of EnvironmentOverride returns null.</value>
<remarks>
<format type="text/markdown"><![CDATA[
## Remarks
The ExecuteTool method passes these environment variables to the StartInfo of the process in which the tool executes. Any environment variables not included in the EnvironmentOverride dictionary are inherited from the process in which the ExecuteTool method executes.
## Examples
```csharp
using System;
using Microsoft.Build.Utilities;
using System.Collections.Specialized;
/// <summary>
/// CustomToolTask overrides the EnvironmentOverride property of ToolTask to add a directory
/// to the Path environment variable of the process being executed
/// </summary>
abstract class CustomToolTask : ToolTask
{
protected override StringDictionary EnvironmentOverride
{
get
{
string newPath = Environment.GetEnvironmentVariable("Path", EnvironmentVariableTarget.Process) + @";C:\MyDirectory";
StringDictionary result = new StringDictionary();
result.Add("Path", newPath);
return result;
}
}
}
```
]]></format>
</remarks>
</Docs>
</Member>
<Member MemberName="EnvironmentVariables">
<MemberSignature Language="C#" Value="public string[] EnvironmentVariables { get; set; }" />
<MemberSignature Language="ILAsm" Value=".property instance string[] EnvironmentVariables" />
<MemberSignature Language="DocId" Value="P:Microsoft.Build.Utilities.ToolTask.EnvironmentVariables" />
<MemberSignature Language="VB.NET" Value="Public Property EnvironmentVariables As String()" />
<MemberSignature Language="C++ CLI" Value="public:
 property cli::array <System::String ^> ^ EnvironmentVariables { cli::array <System::String ^> ^ get(); void set(cli::array <System::String ^> ^ value); };" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Build.Utilities.v4.0</AssemblyName>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.String[]</ReturnType>
</ReturnValue>
<Docs>
<summary>Array of equals-separated pairs of environment variables that should be passed to the spawned executable, in addition to (or selectively overriding) the regular environment block.</summary>
<value>To be added.</value>
<remarks>
<format type="text/markdown"><![CDATA[
## Remarks
Using this instead of EnvironmentOverride as that takes a StringDictionary, which cannot be set from an MSBuild project.
]]></format>
</remarks>
</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.Utilities.ToolTask.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.Utilities.v4.0</AssemblyName>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Boolean</ReturnType>
</ReturnValue>
<Parameters />
<Docs>
<summary>Runs the exectuable file with the specified task parameters.</summary>
<returns>
<see langword="true" /> if the task runs successfully; otherwise, <see langword="false" />.</returns>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="ExecuteTool">
<MemberSignature Language="C#" Value="protected virtual int ExecuteTool (string pathToTool, string responseFileCommands, string commandLineCommands);" />
<MemberSignature Language="ILAsm" Value=".method familyhidebysig newslot virtual instance int32 ExecuteTool(string pathToTool, string responseFileCommands, string commandLineCommands) cil managed" />
<MemberSignature Language="DocId" Value="M:Microsoft.Build.Utilities.ToolTask.ExecuteTool(System.String,System.String,System.String)" />
<MemberSignature Language="VB.NET" Value="Protected Overridable Function ExecuteTool (pathToTool As String, responseFileCommands As String, commandLineCommands As String) As Integer" />
<MemberSignature Language="C++ CLI" Value="protected:
 virtual int ExecuteTool(System::String ^ pathToTool, System::String ^ responseFileCommands, System::String ^ commandLineCommands);" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Build.Utilities.v4.0</AssemblyName>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Int32</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="pathToTool" Type="System.String" />
<Parameter Name="responseFileCommands" Type="System.String" />
<Parameter Name="commandLineCommands" Type="System.String" />
</Parameters>
<Docs>
<param name="pathToTool">The path to the executable file.</param>
<param name="responseFileCommands">The command line arguments to place in the .rsp file.</param>
<param name="commandLineCommands">The command line arguments to pass directly to the executable file.</param>
<summary>Creates a temporoary response (.rsp) file and runs the executable file.</summary>
<returns>The returned exit code of the executable file. If the task logged errors, but the executable returned an exit code of 0, this method returns -1.</returns>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="ExitCode">
<MemberSignature Language="C#" Value="public int ExitCode { get; }" />
<MemberSignature Language="ILAsm" Value=".property instance int32 ExitCode" />
<MemberSignature Language="DocId" Value="P:Microsoft.Build.Utilities.ToolTask.ExitCode" />
<MemberSignature Language="VB.NET" Value="Public ReadOnly Property ExitCode As Integer" />
<MemberSignature Language="C++ CLI" Value="public:
 property int ExitCode { int get(); };" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Build.Utilities.v4.0</AssemblyName>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Attributes>
<Attribute>
<AttributeName>Microsoft.Build.Framework.Output</AttributeName>
</Attribute>
</Attributes>
<ReturnValue>
<ReturnType>System.Int32</ReturnType>
</ReturnValue>
<Docs>
<summary>Gets the returned exit code of the executable file.</summary>
<value>The returned exit code of the executable file. If the task logged errors, but the executable returned an exit code of 0, this method returns -1.</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="GenerateCommandLineCommands">
<MemberSignature Language="C#" Value="protected virtual string GenerateCommandLineCommands ();" />
<MemberSignature Language="ILAsm" Value=".method familyhidebysig newslot virtual instance string GenerateCommandLineCommands() cil managed" />
<MemberSignature Language="DocId" Value="M:Microsoft.Build.Utilities.ToolTask.GenerateCommandLineCommands" />
<MemberSignature Language="VB.NET" Value="Protected Overridable Function GenerateCommandLineCommands () As String" />
<MemberSignature Language="C++ CLI" Value="protected:
 virtual System::String ^ GenerateCommandLineCommands();" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Build.Utilities.v4.0</AssemblyName>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.String</ReturnType>
</ReturnValue>
<Parameters />
<Docs>
<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>
<remarks>
<format type="text/markdown"><. The <xref:Microsoft.Build.Utilities.CommandLineBuilder>, <xref:Microsoft.Build.Utilities.ToolLocationHelper>, and <xref:Microsoft.Build.Utilities.TaskLoggingHelper> classes are used to generate the information needed to run the task.
[!code-csharp[msbuild_ToolTask#1](~/samples/snippets/csharp/VS_Snippets_Misc/msbuild_ToolTask/CS/ILAsm.cs#1)]
[!code-vb[msbuild_ToolTask#1](~/samples/snippets/visualbasic/VS_Snippets_Misc/msbuild_ToolTask/VB/ILAsm.vb#1)]
]]></format>
</remarks>
</Docs>
</Member>
<Member MemberName="GenerateFullPathToTool">
<MemberSignature Language="C#" Value="protected abstract string GenerateFullPathToTool ();" />
<MemberSignature Language="ILAsm" Value=".method familyhidebysig newslot virtual instance string GenerateFullPathToTool() cil managed" />
<MemberSignature Language="DocId" Value="M:Microsoft.Build.Utilities.ToolTask.GenerateFullPathToTool" />
<MemberSignature Language="VB.NET" Value="Protected MustOverride Function GenerateFullPathToTool () As String" />
<MemberSignature Language="C++ CLI" Value="protected:
 abstract System::String ^ GenerateFullPathToTool();" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Build.Utilities.v4.0</AssemblyName>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.String</ReturnType>
</ReturnValue>
<Parameters />
<Docs>
<summary>Returns the fully qualified path to the executable file.</summary>
<returns>The fully qualified path to the executable file.</returns>
<remarks>
<format type="text/markdown"><. The <xref:Microsoft.Build.Utilities.CommandLineBuilder>, <xref:Microsoft.Build.Utilities.ToolLocationHelper>, and <xref:Microsoft.Build.Utilities.TaskLoggingHelper> classes are used to generate the information needed to run the task.
[!code-csharp[msbuild_ToolTask#1](~/samples/snippets/csharp/VS_Snippets_Misc/msbuild_ToolTask/CS/ILAsm.cs#1)]
[!code-vb[msbuild_ToolTask#1](~/samples/snippets/visualbasic/VS_Snippets_Misc/msbuild_ToolTask/VB/ILAsm.vb#1)]
]]></format>
</remarks>
</Docs>
</Member>
<Member MemberName="GenerateResponseFileCommands">
<MemberSignature Language="C#" Value="protected virtual string GenerateResponseFileCommands ();" />
<MemberSignature Language="ILAsm" Value=".method familyhidebysig newslot virtual instance string GenerateResponseFileCommands() cil managed" />
<MemberSignature Language="DocId" Value="M:Microsoft.Build.Utilities.ToolTask.GenerateResponseFileCommands" />
<MemberSignature Language="VB.NET" Value="Protected Overridable Function GenerateResponseFileCommands () As String" />
<MemberSignature Language="C++ CLI" Value="protected:
 virtual System::String ^ GenerateResponseFileCommands();" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Build.Utilities.v4.0</AssemblyName>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.String</ReturnType>
</ReturnValue>
<Parameters />
<Docs>
<summary>Returns a string value containing the command line arguments to add to the response (.rsp) file before running the executable file.</summary>
<returns>a string value containing the command line arguments to add to the response (.rsp) file before running the executable file.</returns>
<remarks>
<format type="text/markdown"><![CDATA[
## Remarks
This method is called after <xref:Microsoft.Build.Utilities.ToolTask.ValidateParameters%2A> and <xref:Microsoft.Build.Utilities.ToolTask.SkipTaskExecution%2A>.
]]></format>
</remarks>
</Docs>
</Member>
<Member MemberName="GetProcessStartInfo">
<MemberSignature Language="C#" Value="protected System.Diagnostics.ProcessStartInfo GetProcessStartInfo (string pathToTool, string commandLineCommands, string responseFileSwitch);" />
<MemberSignature Language="ILAsm" Value=".method familyhidebysig instance class System.Diagnostics.ProcessStartInfo GetProcessStartInfo(string pathToTool, string commandLineCommands, string responseFileSwitch) cil managed" />
<MemberSignature Language="DocId" Value="M:Microsoft.Build.Utilities.ToolTask.GetProcessStartInfo(System.String,System.String,System.String)" />
<MemberSignature Language="VB.NET" Value="Protected Function GetProcessStartInfo (pathToTool As String, commandLineCommands As String, responseFileSwitch As String) As ProcessStartInfo" />
<MemberSignature Language="C++ CLI" Value="protected:
 System::Diagnostics::ProcessStartInfo ^ GetProcessStartInfo(System::String ^ pathToTool, System::String ^ commandLineCommands, System::String ^ responseFileSwitch);" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Build.Utilities.v4.0</AssemblyName>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Diagnostics.ProcessStartInfo</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="pathToTool" Type="System.String" />
<Parameter Name="commandLineCommands" Type="System.String" />
<Parameter Name="responseFileSwitch" Type="System.String" />
</Parameters>
<Docs>
<param name="pathToTool">The path to the tool.</param>
<param name="commandLineCommands">The command line commands.</param>
<param name="responseFileSwitch">The response file switch.</param>
<summary>Initializes the information required to spawn the process executing the tool.</summary>
<returns>The information required to start the process.</returns>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="GetResponseFileSwitch">
<MemberSignature Language="C#" Value="protected virtual string GetResponseFileSwitch (string responseFilePath);" />
<MemberSignature Language="ILAsm" Value=".method familyhidebysig newslot virtual instance string GetResponseFileSwitch(string responseFilePath) cil managed" />
<MemberSignature Language="DocId" Value="M:Microsoft.Build.Utilities.ToolTask.GetResponseFileSwitch(System.String)" />
<MemberSignature Language="VB.NET" Value="Protected Overridable Function GetResponseFileSwitch (responseFilePath As String) As String" />
<MemberSignature Language="C++ CLI" Value="protected:
 virtual System::String ^ GetResponseFileSwitch(System::String ^ responseFilePath);" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Build.Utilities.v4.0</AssemblyName>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.String</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="responseFilePath" Type="System.String" />
</Parameters>
<Docs>
<param name="responseFilePath">The full path to the temporary .rsp file.</param>
<summary>Returns the command line switch used by the executable file to specifiy a response (.rsp) file.</summary>
<returns>The command line switch used by the executable file to specifiy a response (.rsp) file.</returns>
<remarks>
<format type="text/markdown"><![CDATA[
## Remarks
This method is only called if <xref:Microsoft.Build.Utilities.ToolTask.GenerateResponseFileCommands%2A> returns a non-empty string value.
This method is called after <xref:Microsoft.Build.Utilities.ToolTask.ValidateParameters%2A>, <xref:Microsoft.Build.Utilities.ToolTask.SkipTaskExecution%2A> and <xref:Microsoft.Build.Utilities.ToolTask.GenerateResponseFileCommands%2A>.
]]></format>
</remarks>
</Docs>
</Member>
<Member MemberName="GetWorkingDirectory">
<MemberSignature Language="C#" Value="protected virtual string GetWorkingDirectory ();" />
<MemberSignature Language="ILAsm" Value=".method familyhidebysig newslot virtual instance string GetWorkingDirectory() cil managed" />
<MemberSignature Language="DocId" Value="M:Microsoft.Build.Utilities.ToolTask.GetWorkingDirectory" />
<MemberSignature Language="VB.NET" Value="Protected Overridable Function GetWorkingDirectory () As String" />
<MemberSignature Language="C++ CLI" Value="protected:
 virtual System::String ^ GetWorkingDirectory();" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Build.Utilities.v4.0</AssemblyName>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.String</ReturnType>
</ReturnValue>
<Parameters />
<Docs>
<summary>Returns the directory in which to run the executable file.</summary>
<returns>The directory in which to run the executable file, or a null reference (<see langword="Nothing" /> in Visual Basic) if the executable file should be run in the current directory.</returns>
<remarks>
<format type="text/markdown"><![CDATA[
## Remarks
This is a method rather than a property so that derived classes (like Exec) can choose to expose a public WorkingDirectory property, and it would be confusing to have two properties.
]]></format>
</remarks>
</Docs>
</Member>
<Member MemberName="HandleTaskExecutionErrors">
<MemberSignature Language="C#" Value="protected virtual bool HandleTaskExecutionErrors ();" />
<MemberSignature Language="ILAsm" Value=".method familyhidebysig newslot virtual instance bool HandleTaskExecutionErrors() cil managed" />
<MemberSignature Language="DocId" Value="M:Microsoft.Build.Utilities.ToolTask.HandleTaskExecutionErrors" />
<MemberSignature Language="VB.NET" Value="Protected Overridable Function HandleTaskExecutionErrors () As Boolean" />
<MemberSignature Language="C++ CLI" Value="protected:
 virtual bool HandleTaskExecutionErrors();" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Build.Utilities.v4.0</AssemblyName>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Boolean</ReturnType>
</ReturnValue>
<Parameters />
<Docs>
<summary>Handles execution errors raised by the executable file.</summary>
<returns>
<see langword="true" /> if the method runs successfully; otherwise, <see langword="false" />.</returns>
<remarks>
<format type="text/markdown"><![CDATA[
## Remarks
This method is called only if the executable file returns a non-zero exit code.
The return value of this method is used as the return value of the task.
]]></format>
</remarks>
</Docs>
</Member>
<Member MemberName="HasLoggedErrors">
<MemberSignature Language="C#" Value="protected virtual bool HasLoggedErrors { get; }" />
<MemberSignature Language="ILAsm" Value=".property instance bool HasLoggedErrors" />
<MemberSignature Language="DocId" Value="P:Microsoft.Build.Utilities.ToolTask.HasLoggedErrors" />
<MemberSignature Language="VB.NET" Value="Protected Overridable ReadOnly Property HasLoggedErrors As Boolean" />
<MemberSignature Language="C++ CLI" Value="protected:
 virtual property bool HasLoggedErrors { bool get(); };" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Build.Utilities.v4.0</AssemblyName>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Boolean</ReturnType>
</ReturnValue>
<Docs>
<summary>Whether this ToolTask has logged any errors</summary>
<value>To be added.</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="InitializeHostObject">
<MemberSignature Language="C#" Value="protected virtual Microsoft.Build.Utilities.HostObjectInitializationStatus InitializeHostObject ();" />
<MemberSignature Language="ILAsm" Value=".method familyhidebysig newslot virtual instance valuetype Microsoft.Build.Utilities.HostObjectInitializationStatus InitializeHostObject() cil managed" />
<MemberSignature Language="DocId" Value="M:Microsoft.Build.Utilities.ToolTask.InitializeHostObject" />
<MemberSignature Language="VB.NET" Value="Protected Overridable Function InitializeHostObject () As HostObjectInitializationStatus" />
<MemberSignature Language="C++ CLI" Value="protected:
 virtual Microsoft::Build::Utilities::HostObjectInitializationStatus InitializeHostObject();" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Build.Utilities.v4.0</AssemblyName>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>Microsoft.Build.Utilities.HostObjectInitializationStatus</ReturnType>
</ReturnValue>
<Parameters />
<Docs>
<summary>Initializes the host object of the task.</summary>
<returns>The <see cref="T:Microsoft.Build.Utilities.HostObjectInitializationStatus" /> of the host object.</returns>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="LogEventsFromTextOutput">
<MemberSignature Language="C#" Value="protected virtual void LogEventsFromTextOutput (string singleLine, Microsoft.Build.Framework.MessageImportance messageImportance);" />
<MemberSignature Language="ILAsm" Value=".method familyhidebysig newslot virtual instance void LogEventsFromTextOutput(string singleLine, valuetype Microsoft.Build.Framework.MessageImportance messageImportance) cil managed" />
<MemberSignature Language="DocId" Value="M:Microsoft.Build.Utilities.ToolTask.LogEventsFromTextOutput(System.String,Microsoft.Build.Framework.MessageImportance)" />
<MemberSignature Language="C++ CLI" Value="protected:
 virtual void LogEventsFromTextOutput(System::String ^ singleLine, Microsoft::Build::Framework::MessageImportance messageImportance);" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Build.Utilities.v4.0</AssemblyName>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Void</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="singleLine" Type="System.String" />
<Parameter Name="messageImportance" Type="Microsoft.Build.Framework.MessageImportance" />
</Parameters>
<Docs>
<param name="singleLine">A single line of text for the method to parse.</param>
<param name="messageImportance">A value of <see cref="T:Microsoft.Build.Framework.MessageImportance" /> that indicates the importance level with which to log the message.</param>
<summary>Parses a single line of text to identify any errors or warnings in canonical format.</summary>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="LogPathToTool">
<MemberSignature Language="C#" Value="protected virtual void LogPathToTool (string toolName, string pathToTool);" />
<MemberSignature Language="ILAsm" Value=".method familyhidebysig newslot virtual instance void LogPathToTool(string toolName, string pathToTool) cil managed" />
<MemberSignature Language="DocId" Value="M:Microsoft.Build.Utilities.ToolTask.LogPathToTool(System.String,System.String)" />
<MemberSignature Language="VB.NET" Value="Protected Overridable Sub LogPathToTool (toolName As String, pathToTool As String)" />
<MemberSignature Language="C++ CLI" Value="protected:
 virtual void LogPathToTool(System::String ^ toolName, System::String ^ pathToTool);" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Build.Utilities.v4.0</AssemblyName>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Void</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="toolName" Type="System.String" />
<Parameter Name="pathToTool" Type="System.String" />
</Parameters>
<Docs>
<param name="toolName">The executable file name.</param>
<param name="pathToTool">The path to the executable file.</param>
<summary>Logs the tool name and path to all registered loggers.</summary>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="LogStandardErrorAsError">
<MemberSignature Language="C#" Value="public bool LogStandardErrorAsError { get; set; }" />
<MemberSignature Language="ILAsm" Value=".property instance bool LogStandardErrorAsError" />
<MemberSignature Language="DocId" Value="P:Microsoft.Build.Utilities.ToolTask.LogStandardErrorAsError" />
<MemberSignature Language="VB.NET" Value="Public Property LogStandardErrorAsError As Boolean" />
<MemberSignature Language="C++ CLI" Value="public:
 property bool LogStandardErrorAsError { bool get(); void set(bool value); };" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Build.Utilities.v4.0</AssemblyName>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Boolean</ReturnType>
</ReturnValue>
<Docs>
<summary>Should ALL messages received on the standard error stream be logged as errors.</summary>
<value>To be added.</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="LogToolCommand">
<MemberSignature Language="C#" Value="protected virtual void LogToolCommand (string message);" />
<MemberSignature Language="ILAsm" Value=".method familyhidebysig newslot virtual instance void LogToolCommand(string message) cil managed" />
<MemberSignature Language="DocId" Value="M:Microsoft.Build.Utilities.ToolTask.LogToolCommand(System.String)" />
<MemberSignature Language="VB.NET" Value="Protected Overridable Sub LogToolCommand (message As String)" />
<MemberSignature Language="C++ CLI" Value="protected:
 virtual void LogToolCommand(System::String ^ message);" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Build.Utilities.v4.0</AssemblyName>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Void</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="message" Type="System.String" />
</Parameters>
<Docs>
<param name="message">A descriptive message to provide loggers, usually the command line and switches.</param>
<summary>Logs the starting point of the run to all registered loggers.</summary>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="ResponseFileEncoding">
<MemberSignature Language="C#" Value="protected virtual System.Text.Encoding ResponseFileEncoding { get; }" />
<MemberSignature Language="ILAsm" Value=".property instance class System.Text.Encoding ResponseFileEncoding" />
<MemberSignature Language="DocId" Value="P:Microsoft.Build.Utilities.ToolTask.ResponseFileEncoding" />
<MemberSignature Language="VB.NET" Value="Protected Overridable ReadOnly Property ResponseFileEncoding As Encoding" />
<MemberSignature Language="C++ CLI" Value="protected:
 virtual property System::Text::Encoding ^ ResponseFileEncoding { System::Text::Encoding ^ get(); };" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Build.Utilities.v4.0</AssemblyName>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Text.Encoding</ReturnType>
</ReturnValue>
<Docs>
<summary>Gets the <see cref="T:System.Text.Encoding" /> of the response file.</summary>
<value>The <see cref="T:System.Text.Encoding" /> of the response file.</value>
<remarks>
<format type="text/markdown"><![CDATA[
## Remarks
The encoding is <xref:System.Text.Encoding.UTF8%2A> by default.
]]></format>
</remarks>
</Docs>
</Member>
<Member MemberName="ResponseFileEscape">
<MemberSignature Language="C#" Value="protected virtual string ResponseFileEscape (string responseString);" />
<MemberSignature Language="ILAsm" Value=".method familyhidebysig newslot virtual instance string ResponseFileEscape(string responseString) cil managed" />
<MemberSignature Language="DocId" Value="M:Microsoft.Build.Utilities.ToolTask.ResponseFileEscape(System.String)" />
<MemberSignature Language="VB.NET" Value="Protected Overridable Function ResponseFileEscape (responseString As String) As String" />
<MemberSignature Language="C++ CLI" Value="protected:
 virtual System::String ^ ResponseFileEscape(System::String ^ responseString);" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Build.Utilities.v4.0</AssemblyName>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.String</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="responseString" Type="System.String" />
</Parameters>
<Docs>
<param name="responseString">The response string.</param>
<summary>Overridable method to escape the content of the response file.</summary>
<returns>Returns the response string.</returns>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="SkipTaskExecution">
<MemberSignature Language="C#" Value="protected virtual bool SkipTaskExecution ();" />
<MemberSignature Language="ILAsm" Value=".method familyhidebysig newslot virtual instance bool SkipTaskExecution() cil managed" />
<MemberSignature Language="DocId" Value="M:Microsoft.Build.Utilities.ToolTask.SkipTaskExecution" />
<MemberSignature Language="VB.NET" Value="Protected Overridable Function SkipTaskExecution () As Boolean" />
<MemberSignature Language="C++ CLI" Value="protected:
 virtual bool SkipTaskExecution();" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Build.Utilities.v4.0</AssemblyName>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Boolean</ReturnType>
</ReturnValue>
<Parameters />
<Docs>
<summary>Indicates whether task execution should be skipped.</summary>
<returns>
<see langword="true" /> to skip task execution; otherwise, <see langword="false" />.</returns>
<remarks>
<format type="text/markdown"><![CDATA[
## Remarks
This method is called after <xref:Microsoft.Build.Utilities.ToolTask.ValidateParameters%2A>.
]]></format>
</remarks>
</Docs>
</Member>
<Member MemberName="StandardErrorEncoding">
<MemberSignature Language="C#" Value="protected virtual System.Text.Encoding StandardErrorEncoding { get; }" />
<MemberSignature Language="ILAsm" Value=".property instance class System.Text.Encoding StandardErrorEncoding" />
<MemberSignature Language="DocId" Value="P:Microsoft.Build.Utilities.ToolTask.StandardErrorEncoding" />
<MemberSignature Language="VB.NET" Value="Protected Overridable ReadOnly Property StandardErrorEncoding As Encoding" />
<MemberSignature Language="C++ CLI" Value="protected:
 virtual property System::Text::Encoding ^ StandardErrorEncoding { System::Text::Encoding ^ get(); };" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Build.Utilities.v4.0</AssemblyName>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Text.Encoding</ReturnType>
</ReturnValue>
<Docs>
<summary>Gets the <see cref="T:System.Text.Encoding" /> of the standard error stream of the task.</summary>
<value>The <see cref="T:System.Text.Encoding" /> of the response file.</value>
<remarks>
<format type="text/markdown"><![CDATA[
## Remarks
Console-based output uses the current system OEM code page by default. Note that we should not use Console.OutputEncoding here since processes we run don't really have much to do with our console window (and also Console.OutputEncoding doesn't return the OEM code page if the running application that hosts MSBuild is not a console application).
]]></format>
</remarks>
</Docs>
</Member>
<Member MemberName="StandardErrorImportance">
<MemberSignature Language="C#" Value="public string StandardErrorImportance { get; set; }" />
<MemberSignature Language="ILAsm" Value=".property instance string StandardErrorImportance" />
<MemberSignature Language="DocId" Value="P:Microsoft.Build.Utilities.ToolTask.StandardErrorImportance" />
<MemberSignature Language="VB.NET" Value="Public Property StandardErrorImportance As String" />
<MemberSignature Language="C++ CLI" Value="public:
 property System::String ^ StandardErrorImportance { System::String ^ get(); void set(System::String ^ value); };" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Build.Utilities.v4.0</AssemblyName>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.String</ReturnType>
</ReturnValue>
<Docs>
<summary>Task Parameter: Importance with which to log text from the standard error stream.</summary>
<value>To be added.</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="StandardErrorImportanceToUse">
<MemberSignature Language="C#" Value="protected Microsoft.Build.Framework.MessageImportance StandardErrorImportanceToUse { get; }" />
<MemberSignature Language="ILAsm" Value=".property instance valuetype Microsoft.Build.Framework.MessageImportance StandardErrorImportanceToUse" />
<MemberSignature Language="DocId" Value="P:Microsoft.Build.Utilities.ToolTask.StandardErrorImportanceToUse" />
<MemberSignature Language="VB.NET" Value="Protected ReadOnly Property StandardErrorImportanceToUse As MessageImportance" />
<MemberSignature Language="C++ CLI" Value="protected:
 property Microsoft::Build::Framework::MessageImportance StandardErrorImportanceToUse { Microsoft::Build::Framework::MessageImportance get(); };" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Build.Utilities.v4.0</AssemblyName>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>Microsoft.Build.Framework.MessageImportance</ReturnType>
</ReturnValue>
<Docs>
<summary>Gets the actual importance at which standard error messages will be logged.</summary>
<value>Returns the actual importance at which standard error messages will be logged.</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="StandardErrorLoggingImportance">
<MemberSignature Language="C#" Value="protected virtual Microsoft.Build.Framework.MessageImportance StandardErrorLoggingImportance { get; }" />
<MemberSignature Language="ILAsm" Value=".property instance valuetype Microsoft.Build.Framework.MessageImportance StandardErrorLoggingImportance" />
<MemberSignature Language="DocId" Value="P:Microsoft.Build.Utilities.ToolTask.StandardErrorLoggingImportance" />
<MemberSignature Language="VB.NET" Value="Protected Overridable ReadOnly Property StandardErrorLoggingImportance As MessageImportance" />
<MemberSignature Language="C++ CLI" Value="protected:
 virtual property Microsoft::Build::Framework::MessageImportance StandardErrorLoggingImportance { Microsoft::Build::Framework::MessageImportance get(); };" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Build.Utilities.v4.0</AssemblyName>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>Microsoft.Build.Framework.MessageImportance</ReturnType>
</ReturnValue>
<Docs>
<summary>Gets the <see cref="T:Microsoft.Build.Framework.MessageImportance" /> with which to log errors.</summary>
<value>The <see cref="T:Microsoft.Build.Framework.MessageImportance" /> with which to log errors.</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="StandardOutputEncoding">
<MemberSignature Language="C#" Value="protected virtual System.Text.Encoding StandardOutputEncoding { get; }" />
<MemberSignature Language="ILAsm" Value=".property instance class System.Text.Encoding StandardOutputEncoding" />
<MemberSignature Language="DocId" Value="P:Microsoft.Build.Utilities.ToolTask.StandardOutputEncoding" />
<MemberSignature Language="VB.NET" Value="Protected Overridable ReadOnly Property StandardOutputEncoding As Encoding" />
<MemberSignature Language="C++ CLI" Value="protected:
 virtual property System::Text::Encoding ^ StandardOutputEncoding { System::Text::Encoding ^ get(); };" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Build.Utilities.v4.0</AssemblyName>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Text.Encoding</ReturnType>
</ReturnValue>
<Docs>
<summary>Gets the <see cref="T:System.Text.Encoding" /> of the standard output stream of the task.</summary>
<value>The <see cref="T:System.Text.Encoding" /> of the response file.</value>
<remarks>
<format type="text/markdown"><![CDATA[
## Remarks
Console-based output uses the current system OEM code page by default. Note that we should not use Console.OutputEncoding here since processes we run don't really have much to do with our console window (and also Console.OutputEncoding doesn't return the OEM code page if the running application that hosts MSBuild is not a console application).
]]></format>
</remarks>
</Docs>
</Member>
<Member MemberName="StandardOutputImportance">
<MemberSignature Language="C#" Value="public string StandardOutputImportance { get; set; }" />
<MemberSignature Language="ILAsm" Value=".property instance string StandardOutputImportance" />
<MemberSignature Language="DocId" Value="P:Microsoft.Build.Utilities.ToolTask.StandardOutputImportance" />
<MemberSignature Language="VB.NET" Value="Public Property StandardOutputImportance As String" />
<MemberSignature Language="C++ CLI" Value="public:
 property System::String ^ StandardOutputImportance { System::String ^ get(); void set(System::String ^ value); };" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Build.Utilities.v4.0</AssemblyName>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.String</ReturnType>
</ReturnValue>
<Docs>
<summary>Task Parameter: Importance with which to log text from the standard out stream.</summary>
<value>To be added.</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="StandardOutputImportanceToUse">
<MemberSignature Language="C#" Value="protected Microsoft.Build.Framework.MessageImportance StandardOutputImportanceToUse { get; }" />
<MemberSignature Language="ILAsm" Value=".property instance valuetype Microsoft.Build.Framework.MessageImportance StandardOutputImportanceToUse" />
<MemberSignature Language="DocId" Value="P:Microsoft.Build.Utilities.ToolTask.StandardOutputImportanceToUse" />
<MemberSignature Language="VB.NET" Value="Protected ReadOnly Property StandardOutputImportanceToUse As MessageImportance" />
<MemberSignature Language="C++ CLI" Value="protected:
 property Microsoft::Build::Framework::MessageImportance StandardOutputImportanceToUse { Microsoft::Build::Framework::MessageImportance get(); };" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Build.Utilities.v4.0</AssemblyName>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>Microsoft.Build.Framework.MessageImportance</ReturnType>
</ReturnValue>
<Docs>
<summary>Gets the actual importance at which standard out messages will be logged.</summary>
<value>Returns the actual importance at which standard out messages will be logged.</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="StandardOutputLoggingImportance">
<MemberSignature Language="C#" Value="protected virtual Microsoft.Build.Framework.MessageImportance StandardOutputLoggingImportance { get; }" />
<MemberSignature Language="ILAsm" Value=".property instance valuetype Microsoft.Build.Framework.MessageImportance StandardOutputLoggingImportance" />
<MemberSignature Language="DocId" Value="P:Microsoft.Build.Utilities.ToolTask.StandardOutputLoggingImportance" />
<MemberSignature Language="VB.NET" Value="Protected Overridable ReadOnly Property StandardOutputLoggingImportance As MessageImportance" />
<MemberSignature Language="C++ CLI" Value="protected:
 virtual property Microsoft::Build::Framework::MessageImportance StandardOutputLoggingImportance { Microsoft::Build::Framework::MessageImportance get(); };" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Build.Utilities.v4.0</AssemblyName>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>Microsoft.Build.Framework.MessageImportance</ReturnType>
</ReturnValue>
<Docs>
<summary>Gets the <see cref="T:Microsoft.Build.Framework.MessageImportance" /> with which to log errors.</summary>
<value>The <see cref="T:Microsoft.Build.Framework.MessageImportance" /> with which to log errors.</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="TaskProcessTerminationTimeout">
<MemberSignature Language="C#" Value="protected int TaskProcessTerminationTimeout { get; set; }" />
<MemberSignature Language="ILAsm" Value=".property instance int32 TaskProcessTerminationTimeout" />
<MemberSignature Language="DocId" Value="P:Microsoft.Build.Utilities.ToolTask.TaskProcessTerminationTimeout" />
<MemberSignature Language="VB.NET" Value="Protected Property TaskProcessTerminationTimeout As Integer" />
<MemberSignature Language="C++ CLI" Value="protected:
 property int TaskProcessTerminationTimeout { int get(); void set(int value); };" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Build.Utilities.v4.0</AssemblyName>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Int32</ReturnType>
</ReturnValue>
<Docs>
<summary>A timeout to wait for a task to terminate before killing it. In milliseconds.</summary>
<value>To be added.</value>
<remarks>To be added.</remarks>
</Docs>