-
Notifications
You must be signed in to change notification settings - Fork 14
/
TaskCommandLineEventArgs.xml
196 lines (196 loc) · 13.5 KB
/
TaskCommandLineEventArgs.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
<Type Name="TaskCommandLineEventArgs" FullName="Microsoft.Build.Framework.TaskCommandLineEventArgs">
<TypeSignature Language="C#" Value="public class TaskCommandLineEventArgs : Microsoft.Build.Framework.BuildMessageEventArgs" />
<TypeSignature Language="ILAsm" Value=".class public auto ansi serializable beforefieldinit TaskCommandLineEventArgs extends Microsoft.Build.Framework.BuildMessageEventArgs" />
<TypeSignature Language="DocId" Value="T:Microsoft.Build.Framework.TaskCommandLineEventArgs" />
<TypeSignature Language="VB.NET" Value="Public Class TaskCommandLineEventArgs
Inherits BuildMessageEventArgs" />
<TypeSignature Language="F#" Value="type TaskCommandLineEventArgs = class
 inherit BuildMessageEventArgs" />
<TypeSignature Language="C++ CLI" Value="public ref class TaskCommandLineEventArgs : Microsoft::Build::Framework::BuildMessageEventArgs" />
<AssemblyInfo>
<AssemblyName>Microsoft.Build.Framework</AssemblyName>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
<AssemblyVersion>3.5.0.0</AssemblyVersion>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
<AssemblyVersion>15.1.0.0</AssemblyVersion>
</AssemblyInfo>
<Base>
<BaseTypeName>Microsoft.Build.Framework.BuildMessageEventArgs</BaseTypeName>
</Base>
<Interfaces />
<Attributes>
<Attribute>
<AttributeName Language="C#">[System.Serializable]</AttributeName>
<AttributeName Language="F#">[<System.Serializable>]</AttributeName>
</Attribute>
</Attributes>
<Docs>
<summary>
This class is used by tasks to log their command lines. This class extends
<see cref="T:Microsoft.Build.Framework.BuildMessageEventArgs" /> so that command lines can be logged as
messages. Logging a command line is only relevant for tasks that wrap an
underlying executable/tool, or emulate a shell command. Tasks that have
no command line equivalent should not raise this extended message event.
</summary>
<remarks>
WARNING: marking a type [Serializable] without implementing ISerializable
imposes a serialization contract -- it is a promise to never change the
type's fields i.e. the type is immutable; adding new fields in the next
version of the type without following certain special FX guidelines, can
break both forward and backward compatibility
</remarks>
</Docs>
<Members>
<MemberGroup MemberName=".ctor">
<AssemblyInfo>
<AssemblyName>Microsoft.Build.Framework</AssemblyName>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Docs>
<summary>Initializes a new instance of the <see cref="T:Microsoft.Build.Framework.TaskCommandLineEventArgs" /> class.</summary>
</Docs>
</MemberGroup>
<Member MemberName=".ctor">
<MemberSignature Language="C#" Value="protected TaskCommandLineEventArgs ();" />
<MemberSignature Language="ILAsm" Value=".method familyhidebysig specialname rtspecialname instance void .ctor() cil managed" />
<MemberSignature Language="DocId" Value="M:Microsoft.Build.Framework.TaskCommandLineEventArgs.#ctor" />
<MemberSignature Language="VB.NET" Value="Protected Sub New ()" />
<MemberSignature Language="C++ CLI" Value="protected:
 TaskCommandLineEventArgs();" />
<MemberType>Constructor</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Build.Framework</AssemblyName>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
<AssemblyVersion>3.5.0.0</AssemblyVersion>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
<AssemblyVersion>15.1.0.0</AssemblyVersion>
</AssemblyInfo>
<Attributes>
<Attribute FrameworkAlternate="netframework-4.0">
<AttributeName Language="C#">[System.Runtime.TargetedPatchingOptOut("Performance critical to inline this type of method across NGen image boundaries")]</AttributeName>
<AttributeName Language="F#">[<System.Runtime.TargetedPatchingOptOut("Performance critical to inline this type of method across NGen image boundaries")>]</AttributeName>
</Attribute>
</Attributes>
<Parameters />
<Docs>
<summary>
Default (family) constructor.
</summary>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName=".ctor">
<MemberSignature Language="C#" Value="public TaskCommandLineEventArgs (string commandLine, string taskName, Microsoft.Build.Framework.MessageImportance importance);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig specialname rtspecialname instance void .ctor(string commandLine, string taskName, valuetype Microsoft.Build.Framework.MessageImportance importance) cil managed" />
<MemberSignature Language="DocId" Value="M:Microsoft.Build.Framework.TaskCommandLineEventArgs.#ctor(System.String,System.String,Microsoft.Build.Framework.MessageImportance)" />
<MemberSignature Language="VB.NET" Value="Public Sub New (commandLine As String, taskName As String, importance As MessageImportance)" />
<MemberSignature Language="F#" Value="new Microsoft.Build.Framework.TaskCommandLineEventArgs : string * string * Microsoft.Build.Framework.MessageImportance -> Microsoft.Build.Framework.TaskCommandLineEventArgs" Usage="new Microsoft.Build.Framework.TaskCommandLineEventArgs (commandLine, taskName, importance)" />
<MemberSignature Language="C++ CLI" Value="public:
 TaskCommandLineEventArgs(System::String ^ commandLine, System::String ^ taskName, Microsoft::Build::Framework::MessageImportance importance);" />
<MemberType>Constructor</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Build.Framework</AssemblyName>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
<AssemblyVersion>3.5.0.0</AssemblyVersion>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
<AssemblyVersion>15.1.0.0</AssemblyVersion>
</AssemblyInfo>
<Parameters>
<Parameter Name="commandLine" Type="System.String" />
<Parameter Name="taskName" Type="System.String" />
<Parameter Name="importance" Type="Microsoft.Build.Framework.MessageImportance" />
</Parameters>
<Docs>
<param name="commandLine">The command line used by a task to launch
its underlying tool/executable.</param>
<param name="taskName">The name of the task raising this event.</param>
<param name="importance">Importance of command line -- controls whether
the command line will be displayed by less verbose loggers.</param>
<summary>
Creates an instance of this class for the given task command line.
</summary>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName=".ctor">
<MemberSignature Language="C#" Value="public TaskCommandLineEventArgs (string commandLine, string taskName, Microsoft.Build.Framework.MessageImportance importance, DateTime eventTimestamp);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig specialname rtspecialname instance void .ctor(string commandLine, string taskName, valuetype Microsoft.Build.Framework.MessageImportance importance, valuetype System.DateTime eventTimestamp) cil managed" />
<MemberSignature Language="DocId" Value="M:Microsoft.Build.Framework.TaskCommandLineEventArgs.#ctor(System.String,System.String,Microsoft.Build.Framework.MessageImportance,System.DateTime)" />
<MemberSignature Language="VB.NET" Value="Public Sub New (commandLine As String, taskName As String, importance As MessageImportance, eventTimestamp As DateTime)" />
<MemberSignature Language="F#" Value="new Microsoft.Build.Framework.TaskCommandLineEventArgs : string * string * Microsoft.Build.Framework.MessageImportance * DateTime -> Microsoft.Build.Framework.TaskCommandLineEventArgs" Usage="new Microsoft.Build.Framework.TaskCommandLineEventArgs (commandLine, taskName, importance, eventTimestamp)" />
<MemberSignature Language="C++ CLI" Value="public:
 TaskCommandLineEventArgs(System::String ^ commandLine, System::String ^ taskName, Microsoft::Build::Framework::MessageImportance importance, DateTime eventTimestamp);" />
<MemberType>Constructor</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Build.Framework</AssemblyName>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
<AssemblyVersion>15.1.0.0</AssemblyVersion>
</AssemblyInfo>
<Parameters>
<Parameter Name="commandLine" Type="System.String" Index="0" FrameworkAlternate="msbuild-15;msbuild-15-netcore;msbuild-16;msbuild-16-netcore;msbuild-17;msbuild-17-netcore;netframework-4.0;netframework-4.5;netframework-4.5.1;netframework-4.5.2;netframework-4.6;netframework-4.6.1;netframework-4.6.2;netframework-4.7;netframework-4.7.1;netframework-4.7.2;netframework-4.8;netframework-4.8.1" />
<Parameter Name="taskName" Type="System.String" Index="1" FrameworkAlternate="msbuild-15;msbuild-15-netcore;msbuild-16;msbuild-16-netcore;msbuild-17;msbuild-17-netcore;netframework-4.0;netframework-4.5;netframework-4.5.1;netframework-4.5.2;netframework-4.6;netframework-4.6.1;netframework-4.6.2;netframework-4.7;netframework-4.7.1;netframework-4.7.2;netframework-4.8;netframework-4.8.1" />
<Parameter Name="importance" Type="Microsoft.Build.Framework.MessageImportance" Index="2" FrameworkAlternate="msbuild-15;msbuild-15-netcore;msbuild-16;msbuild-16-netcore;msbuild-17;msbuild-17-netcore;netframework-4.0;netframework-4.5;netframework-4.5.1;netframework-4.5.2;netframework-4.6;netframework-4.6.1;netframework-4.6.2;netframework-4.7;netframework-4.7.1;netframework-4.7.2;netframework-4.8;netframework-4.8.1" />
<Parameter Name="eventTimestamp" Type="System.DateTime" Index="3" FrameworkAlternate="msbuild-15;msbuild-15-netcore;msbuild-16;msbuild-16-netcore;msbuild-17;msbuild-17-netcore;netframework-4.0;netframework-4.5;netframework-4.5.1;netframework-4.5.2;netframework-4.6;netframework-4.6.1;netframework-4.6.2;netframework-4.7;netframework-4.7.1;netframework-4.7.2;netframework-4.8;netframework-4.8.1" />
</Parameters>
<Docs>
<param name="commandLine">The command line used by a task to launch
its underlying tool/executable.</param>
<param name="taskName">The name of the task raising this event.</param>
<param name="importance">Importance of command line -- controls whether
the command line will be displayed by less verbose loggers.</param>
<param name="eventTimestamp">Timestamp when the event was created</param>
<summary>
Creates an instance of this class for the given task command line. This constructor allows the timestamp to be set
</summary>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="CommandLine">
<MemberSignature Language="C#" Value="public string CommandLine { get; }" />
<MemberSignature Language="ILAsm" Value=".property instance string CommandLine" />
<MemberSignature Language="DocId" Value="P:Microsoft.Build.Framework.TaskCommandLineEventArgs.CommandLine" />
<MemberSignature Language="VB.NET" Value="Public ReadOnly Property CommandLine As String" />
<MemberSignature Language="F#" Value="member this.CommandLine : string" Usage="Microsoft.Build.Framework.TaskCommandLineEventArgs.CommandLine" />
<MemberSignature Language="C++ CLI" Value="public:
 property System::String ^ CommandLine { System::String ^ get(); };" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Build.Framework</AssemblyName>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
<AssemblyVersion>3.5.0.0</AssemblyVersion>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
<AssemblyVersion>15.1.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.String</ReturnType>
</ReturnValue>
<Docs>
<summary>
Gets the task command line associated with this event.
</summary>
<value>The command line used by the task to run the underlying program.</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="TaskName">
<MemberSignature Language="C#" Value="public string TaskName { get; }" />
<MemberSignature Language="ILAsm" Value=".property instance string TaskName" />
<MemberSignature Language="DocId" Value="P:Microsoft.Build.Framework.TaskCommandLineEventArgs.TaskName" />
<MemberSignature Language="VB.NET" Value="Public ReadOnly Property TaskName As String" />
<MemberSignature Language="F#" Value="member this.TaskName : string" Usage="Microsoft.Build.Framework.TaskCommandLineEventArgs.TaskName" />
<MemberSignature Language="C++ CLI" Value="public:
 property System::String ^ TaskName { System::String ^ get(); };" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Build.Framework</AssemblyName>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
<AssemblyVersion>3.5.0.0</AssemblyVersion>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
<AssemblyVersion>15.1.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.String</ReturnType>
</ReturnValue>
<Docs>
<summary>
Gets the name of the task that raised this event.
</summary>
<value>The name of the task that raised the event.</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
</Members>
</Type>