-
Notifications
You must be signed in to change notification settings - Fork 14
/
ITaskFactory.xml
199 lines (199 loc) · 12.5 KB
/
ITaskFactory.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
<Type Name="ITaskFactory" FullName="Microsoft.Build.Framework.ITaskFactory">
<TypeSignature Language="C#" Value="public interface ITaskFactory" />
<TypeSignature Language="ILAsm" Value=".class public interface auto ansi abstract ITaskFactory" FrameworkAlternate="msbuild-15;msbuild-15-netcore;msbuild-16;msbuild-16-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" />
<TypeSignature Language="DocId" Value="T:Microsoft.Build.Framework.ITaskFactory" />
<TypeSignature Language="VB.NET" Value="Public Interface ITaskFactory" />
<TypeSignature Language="F#" Value="type ITaskFactory = interface" />
<TypeSignature Language="C++ CLI" Value="public interface class ITaskFactory" />
<TypeSignature Language="ILAsm" Value=".class public interface auto ansi abstract beforefieldinit ITaskFactory" FrameworkAlternate="msbuild-17;msbuild-17-netcore" />
<AssemblyInfo>
<AssemblyName>Microsoft.Build.Framework</AssemblyName>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
<AssemblyVersion>15.1.0.0</AssemblyVersion>
</AssemblyInfo>
<Interfaces />
<Docs>
<summary>
Interface that a task factory Instance should implement
</summary>
<remarks>To be added.</remarks>
</Docs>
<Members>
<Member MemberName="CleanupTask">
<MemberSignature Language="C#" Value="public void CleanupTask (Microsoft.Build.Framework.ITask task);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance void CleanupTask(class Microsoft.Build.Framework.ITask task) cil managed" />
<MemberSignature Language="DocId" Value="M:Microsoft.Build.Framework.ITaskFactory.CleanupTask(Microsoft.Build.Framework.ITask)" />
<MemberSignature Language="VB.NET" Value="Public Sub CleanupTask (task As ITask)" />
<MemberSignature Language="F#" Value="abstract member CleanupTask : Microsoft.Build.Framework.ITask -> unit" Usage="iTaskFactory.CleanupTask task" />
<MemberSignature Language="C++ CLI" Value="public:
 void CleanupTask(Microsoft::Build::Framework::ITask ^ task);" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Build.Framework</AssemblyName>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
<AssemblyVersion>15.1.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Void</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="task" Type="Microsoft.Build.Framework.ITask" />
</Parameters>
<Docs>
<param name="task">The task to clean up.</param>
<summary>
Cleans up any context or state that may have been built up for a given task.
</summary>
<remarks>
For many factories, this method is a no-op. But some factories may have built up
an AppDomain as part of an individual task instance, and this is their opportunity
to shutdown the AppDomain.
</remarks>
</Docs>
</Member>
<Member MemberName="CreateTask">
<MemberSignature Language="C#" Value="public Microsoft.Build.Framework.ITask CreateTask (Microsoft.Build.Framework.IBuildEngine taskFactoryLoggingHost);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance class Microsoft.Build.Framework.ITask CreateTask(class Microsoft.Build.Framework.IBuildEngine taskFactoryLoggingHost) cil managed" />
<MemberSignature Language="DocId" Value="M:Microsoft.Build.Framework.ITaskFactory.CreateTask(Microsoft.Build.Framework.IBuildEngine)" />
<MemberSignature Language="VB.NET" Value="Public Function CreateTask (taskFactoryLoggingHost As IBuildEngine) As ITask" />
<MemberSignature Language="F#" Value="abstract member CreateTask : Microsoft.Build.Framework.IBuildEngine -> Microsoft.Build.Framework.ITask" Usage="iTaskFactory.CreateTask taskFactoryLoggingHost" />
<MemberSignature Language="C++ CLI" Value="public:
 Microsoft::Build::Framework::ITask ^ CreateTask(Microsoft::Build::Framework::IBuildEngine ^ taskFactoryLoggingHost);" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Build.Framework</AssemblyName>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
<AssemblyVersion>15.1.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>Microsoft.Build.Framework.ITask</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="taskFactoryLoggingHost" Type="Microsoft.Build.Framework.IBuildEngine" />
</Parameters>
<Docs>
<param name="taskFactoryLoggingHost">
The task factory logging host will log messages in the context of the task.
</param>
<summary>
Create an instance of the task to be used.
</summary>
<returns>
The generated task, or <c>null</c> if the task failed to be created.
</returns>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="FactoryName">
<MemberSignature Language="C#" Value="public string FactoryName { get; }" />
<MemberSignature Language="ILAsm" Value=".property instance string FactoryName" />
<MemberSignature Language="DocId" Value="P:Microsoft.Build.Framework.ITaskFactory.FactoryName" />
<MemberSignature Language="VB.NET" Value="Public ReadOnly Property FactoryName As String" />
<MemberSignature Language="F#" Value="member this.FactoryName : string" Usage="Microsoft.Build.Framework.ITaskFactory.FactoryName" />
<MemberSignature Language="C++ CLI" Value="public:
 property System::String ^ FactoryName { System::String ^ get(); };" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Build.Framework</AssemblyName>
<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 factory.
</summary>
<value>The name of the factory.</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="GetTaskParameters">
<MemberSignature Language="C#" Value="public Microsoft.Build.Framework.TaskPropertyInfo[] GetTaskParameters ();" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance class Microsoft.Build.Framework.TaskPropertyInfo[] GetTaskParameters() cil managed" />
<MemberSignature Language="DocId" Value="M:Microsoft.Build.Framework.ITaskFactory.GetTaskParameters" />
<MemberSignature Language="VB.NET" Value="Public Function GetTaskParameters () As TaskPropertyInfo()" />
<MemberSignature Language="F#" Value="abstract member GetTaskParameters : unit -> Microsoft.Build.Framework.TaskPropertyInfo[]" Usage="iTaskFactory.GetTaskParameters " />
<MemberSignature Language="C++ CLI" Value="public:
 cli::array <Microsoft::Build::Framework::TaskPropertyInfo ^> ^ GetTaskParameters();" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Build.Framework</AssemblyName>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
<AssemblyVersion>15.1.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>Microsoft.Build.Framework.TaskPropertyInfo[]</ReturnType>
</ReturnValue>
<Parameters />
<Docs>
<summary>
Get the descriptions for all the task's parameters.
</summary>
<returns>A non-null array of property descriptions.</returns>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="Initialize">
<MemberSignature Language="C#" Value="public bool Initialize (string taskName, System.Collections.Generic.IDictionary<string,Microsoft.Build.Framework.TaskPropertyInfo> parameterGroup, string taskBody, Microsoft.Build.Framework.IBuildEngine taskFactoryLoggingHost);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance bool Initialize(string taskName, class System.Collections.Generic.IDictionary`2<string, class Microsoft.Build.Framework.TaskPropertyInfo> parameterGroup, string taskBody, class Microsoft.Build.Framework.IBuildEngine taskFactoryLoggingHost) cil managed" />
<MemberSignature Language="DocId" Value="M:Microsoft.Build.Framework.ITaskFactory.Initialize(System.String,System.Collections.Generic.IDictionary{System.String,Microsoft.Build.Framework.TaskPropertyInfo},System.String,Microsoft.Build.Framework.IBuildEngine)" />
<MemberSignature Language="VB.NET" Value="Public Function Initialize (taskName As String, parameterGroup As IDictionary(Of String, TaskPropertyInfo), taskBody As String, taskFactoryLoggingHost As IBuildEngine) As Boolean" />
<MemberSignature Language="F#" Value="abstract member Initialize : string * System.Collections.Generic.IDictionary<string, Microsoft.Build.Framework.TaskPropertyInfo> * string * Microsoft.Build.Framework.IBuildEngine -> bool" Usage="iTaskFactory.Initialize (taskName, parameterGroup, taskBody, taskFactoryLoggingHost)" />
<MemberSignature Language="C++ CLI" Value="public:
 bool Initialize(System::String ^ taskName, System::Collections::Generic::IDictionary<System::String ^, Microsoft::Build::Framework::TaskPropertyInfo ^> ^ parameterGroup, System::String ^ taskBody, Microsoft::Build::Framework::IBuildEngine ^ taskFactoryLoggingHost);" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Build.Framework</AssemblyName>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
<AssemblyVersion>15.1.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Boolean</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="taskName" Type="System.String" />
<Parameter Name="parameterGroup" Type="System.Collections.Generic.IDictionary<System.String,Microsoft.Build.Framework.TaskPropertyInfo>" />
<Parameter Name="taskBody" Type="System.String" />
<Parameter Name="taskFactoryLoggingHost" Type="Microsoft.Build.Framework.IBuildEngine" />
</Parameters>
<Docs>
<param name="taskName">Name of the task.</param>
<param name="parameterGroup">The parameter group.</param>
<param name="taskBody">The task body.</param>
<param name="taskFactoryLoggingHost">The task factory logging host.</param>
<summary>
Initializes this factory for instantiating tasks with a particular inline task block.
</summary>
<returns>A value indicating whether initialization was successful.</returns>
<remarks>
<para>MSBuild engine will call this to initialize the factory. This should initialize the factory enough so that the factory can be asked
whether or not task names can be created by the factory.</para>
<para>
The taskFactoryLoggingHost will log messages in the context of the target where the task is first used.
</para>
</remarks>
</Docs>
</Member>
<Member MemberName="TaskType">
<MemberSignature Language="C#" Value="public Type TaskType { get; }" />
<MemberSignature Language="ILAsm" Value=".property instance class System.Type TaskType" />
<MemberSignature Language="DocId" Value="P:Microsoft.Build.Framework.ITaskFactory.TaskType" />
<MemberSignature Language="VB.NET" Value="Public ReadOnly Property TaskType As Type" />
<MemberSignature Language="F#" Value="member this.TaskType : Type" Usage="Microsoft.Build.Framework.ITaskFactory.TaskType" />
<MemberSignature Language="C++ CLI" Value="public:
 property Type ^ TaskType { Type ^ get(); };" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Build.Framework</AssemblyName>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
<AssemblyVersion>15.1.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Type</ReturnType>
</ReturnValue>
<Docs>
<summary>
Gets the type of the task this factory will instantiate. Implementations must return a value for this property.
</summary>
<value>The type of task.</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
</Members>
</Type>