-
Notifications
You must be signed in to change notification settings - Fork 15
/
HostServices.xml
310 lines (303 loc) · 18.6 KB
/
HostServices.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
<Type Name="HostServices" FullName="Microsoft.Build.Execution.HostServices">
<TypeSignature Language="C#" Value="public class HostServices" />
<TypeSignature Language="ILAsm" Value=".class public auto ansi beforefieldinit HostServices extends System.Object" />
<TypeSignature Language="DocId" Value="T:Microsoft.Build.Execution.HostServices" />
<TypeSignature Language="VB.NET" Value="Public Class HostServices" />
<TypeSignature Language="F#" Value="type HostServices = class" />
<TypeSignature Language="C++ CLI" Value="public ref class HostServices" />
<AssemblyInfo>
<AssemblyName>Microsoft.Build</AssemblyName>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
<AssemblyVersion>15.1.0.0</AssemblyVersion>
</AssemblyInfo>
<Base>
<BaseTypeName>System.Object</BaseTypeName>
</Base>
<Interfaces />
<Attributes>
<Attribute FrameworkAlternate="msbuild-15;msbuild-15-netcore;msbuild-16;msbuild-16-netcore;msbuild-17;msbuild-17-netcore">
<AttributeName Language="C#">[System.Diagnostics.DebuggerDisplay("#Entries={_hostObjectMap.Count}")]</AttributeName>
<AttributeName Language="F#">[<System.Diagnostics.DebuggerDisplay("#Entries={_hostObjectMap.Count}")>]</AttributeName>
</Attribute>
<Attribute FrameworkAlternate="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">
<AttributeName Language="C#">[System.Diagnostics.DebuggerDisplay("#Entries={hostObjectMap.Count}")]</AttributeName>
<AttributeName Language="F#">[<System.Diagnostics.DebuggerDisplay("#Entries={hostObjectMap.Count}")>]</AttributeName>
</Attribute>
</Attributes>
<Docs>
<summary>
Implementation of HostServices that
mediates access from the build to the host.
</summary>
<remarks>
<format type="text/markdown"><![CDATA[
## Remarks
See also <xref:Microsoft.Build.Utilities.Task.HostObject%2A>.
]]></format>
</remarks>
</Docs>
<Members>
<Member MemberName=".ctor">
<MemberSignature Language="C#" Value="public HostServices ();" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig specialname rtspecialname instance void .ctor() cil managed" />
<MemberSignature Language="DocId" Value="M:Microsoft.Build.Execution.HostServices.#ctor" />
<MemberSignature Language="VB.NET" Value="Public Sub New ()" />
<MemberSignature Language="C++ CLI" Value="public:
 HostServices();" />
<MemberType>Constructor</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Build</AssemblyName>
<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>Creates a host service.</summary>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="GetHostObject">
<MemberSignature Language="C#" Value="public Microsoft.Build.Framework.ITaskHost GetHostObject (string projectFile, string targetName, string taskName);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig instance class Microsoft.Build.Framework.ITaskHost GetHostObject(string projectFile, string targetName, string taskName) cil managed" />
<MemberSignature Language="DocId" Value="M:Microsoft.Build.Execution.HostServices.GetHostObject(System.String,System.String,System.String)" />
<MemberSignature Language="VB.NET" Value="Public Function GetHostObject (projectFile As String, targetName As String, taskName As String) As ITaskHost" />
<MemberSignature Language="F#" Value="member this.GetHostObject : string * string * string -> Microsoft.Build.Framework.ITaskHost" Usage="hostServices.GetHostObject (projectFile, targetName, taskName)" />
<MemberSignature Language="C++ CLI" Value="public:
 Microsoft::Build::Framework::ITaskHost ^ GetHostObject(System::String ^ projectFile, System::String ^ targetName, System::String ^ taskName);" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Build</AssemblyName>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
<AssemblyVersion>15.1.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>Microsoft.Build.Framework.ITaskHost</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="projectFile" Type="System.String" />
<Parameter Name="targetName" Type="System.String" />
<Parameter Name="taskName" Type="System.String" />
</Parameters>
<Docs>
<param name="projectFile">The name of the project file.</param>
<param name="targetName">The name of the target.</param>
<param name="taskName">The task name associated with the host service.</param>
<summary>
Gets any host object applicable to this task name
where the task appears within a target and project with the specified names.
If no host object exists, returns null.
</summary>
<returns>The host service for the given task where the task appears within a target and project with the given names. If no host service exists, returns null.</returns>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="GetNodeAffinity">
<MemberSignature Language="C#" Value="public Microsoft.Build.Execution.NodeAffinity GetNodeAffinity (string projectFile);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig instance valuetype Microsoft.Build.Execution.NodeAffinity GetNodeAffinity(string projectFile) cil managed" />
<MemberSignature Language="DocId" Value="M:Microsoft.Build.Execution.HostServices.GetNodeAffinity(System.String)" />
<MemberSignature Language="VB.NET" Value="Public Function GetNodeAffinity (projectFile As String) As NodeAffinity" />
<MemberSignature Language="F#" Value="member this.GetNodeAffinity : string -> Microsoft.Build.Execution.NodeAffinity" Usage="hostServices.GetNodeAffinity projectFile" />
<MemberSignature Language="C++ CLI" Value="public:
 Microsoft::Build::Execution::NodeAffinity GetNodeAffinity(System::String ^ projectFile);" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Build</AssemblyName>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
<AssemblyVersion>15.1.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>Microsoft.Build.Execution.NodeAffinity</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="projectFile" Type="System.String" />
</Parameters>
<Docs>
<param name="projectFile">The project file associated with the node.</param>
<summary>
Retrieves the node affinity for a particular project file.
</summary>
<returns>The node affinity for the given project file.</returns>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="OnRenameProject">
<MemberSignature Language="C#" Value="public void OnRenameProject (string oldFullPath, string newFullPath);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig instance void OnRenameProject(string oldFullPath, string newFullPath) cil managed" />
<MemberSignature Language="DocId" Value="M:Microsoft.Build.Execution.HostServices.OnRenameProject(System.String,System.String)" />
<MemberSignature Language="VB.NET" Value="Public Sub OnRenameProject (oldFullPath As String, newFullPath As String)" />
<MemberSignature Language="F#" Value="member this.OnRenameProject : string * string -> unit" Usage="hostServices.OnRenameProject (oldFullPath, newFullPath)" />
<MemberSignature Language="C++ CLI" Value="public:
 void OnRenameProject(System::String ^ oldFullPath, System::String ^ newFullPath);" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Build</AssemblyName>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
<AssemblyVersion>15.1.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Void</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="oldFullPath" Type="System.String" />
<Parameter Name="newFullPath" Type="System.String" />
</Parameters>
<Docs>
<param name="oldFullPath">The current path to the project file.</param>
<param name="newFullPath">The new path to the project file.</param>
<summary>
Updates the host object table when a project is renamed.
Old full path may be null.
</summary>
<remarks>
<format type="text/markdown"><![CDATA[
## Remarks
A project is named when it is given a new full path and the old path is null.
]]></format>
</remarks>
</Docs>
</Member>
<Member MemberName="RegisterHostObject">
<MemberSignature Language="C#" Value="public void RegisterHostObject (string projectFile, string targetName, string taskName, Microsoft.Build.Framework.ITaskHost hostObject);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig instance void RegisterHostObject(string projectFile, string targetName, string taskName, class Microsoft.Build.Framework.ITaskHost hostObject) cil managed" />
<MemberSignature Language="DocId" Value="M:Microsoft.Build.Execution.HostServices.RegisterHostObject(System.String,System.String,System.String,Microsoft.Build.Framework.ITaskHost)" />
<MemberSignature Language="VB.NET" Value="Public Sub RegisterHostObject (projectFile As String, targetName As String, taskName As String, hostObject As ITaskHost)" />
<MemberSignature Language="F#" Value="member this.RegisterHostObject : string * string * string * Microsoft.Build.Framework.ITaskHost -> unit" Usage="hostServices.RegisterHostObject (projectFile, targetName, taskName, hostObject)" />
<MemberSignature Language="C++ CLI" Value="public:
 void RegisterHostObject(System::String ^ projectFile, System::String ^ targetName, System::String ^ taskName, Microsoft::Build::Framework::ITaskHost ^ hostObject);" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Build</AssemblyName>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
<AssemblyVersion>15.1.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Void</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="projectFile" Type="System.String" />
<Parameter Name="targetName" Type="System.String" />
<Parameter Name="taskName" Type="System.String" />
<Parameter Name="hostObject" Type="Microsoft.Build.Framework.ITaskHost" />
</Parameters>
<Docs>
<param name="projectFile">The project file containing the task/target pair.</param>
<param name="targetName">The name of the target.</param>
<param name="taskName">The name of the task.</param>
<param name="hostObject">The host service.</param>
<summary>
Register a host object for a particular task/target pair.
Overwrites any existing host object.
</summary>
<remarks>
<format type="text/markdown"><![CDATA[
## Remarks
Overwrites any existing host service.
]]></format>
</remarks>
</Docs>
</Member>
<Member MemberName="RegisterHostObject">
<MemberSignature Language="C#" Value="public void RegisterHostObject (string projectFile, string targetName, string taskName, string monikerName);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig instance void RegisterHostObject(string projectFile, string targetName, string taskName, string monikerName) cil managed" />
<MemberSignature Language="DocId" Value="M:Microsoft.Build.Execution.HostServices.RegisterHostObject(System.String,System.String,System.String,System.String)" />
<MemberSignature Language="VB.NET" Value="Public Sub RegisterHostObject (projectFile As String, targetName As String, taskName As String, monikerName As String)" />
<MemberSignature Language="F#" Value="member this.RegisterHostObject : string * string * string * string -> unit" Usage="hostServices.RegisterHostObject (projectFile, targetName, taskName, monikerName)" />
<MemberSignature Language="C++ CLI" Value="public:
 void RegisterHostObject(System::String ^ projectFile, System::String ^ targetName, System::String ^ taskName, System::String ^ monikerName);" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Build</AssemblyName>
<AssemblyVersion>15.1.0.0</AssemblyVersion>
</AssemblyInfo>
<Attributes>
<Attribute FrameworkAlternate="msbuild-17-netcore">
<AttributeName Language="C#">[System.Runtime.Versioning.SupportedOSPlatform("windows")]</AttributeName>
<AttributeName Language="F#">[<System.Runtime.Versioning.SupportedOSPlatform("windows")>]</AttributeName>
</Attribute>
</Attributes>
<ReturnValue>
<ReturnType>System.Void</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="projectFile" Type="System.String" Index="0" FrameworkAlternate="msbuild-16;msbuild-17;msbuild-17-netcore" />
<Parameter Name="targetName" Type="System.String" Index="1" FrameworkAlternate="msbuild-16;msbuild-17;msbuild-17-netcore" />
<Parameter Name="taskName" Type="System.String" Index="2" FrameworkAlternate="msbuild-16;msbuild-17;msbuild-17-netcore" />
<Parameter Name="monikerName" Type="System.String" Index="3" FrameworkAlternate="msbuild-16;msbuild-17;msbuild-17-netcore" />
</Parameters>
<Docs>
<param name="projectFile">project file name</param>
<param name="targetName">target name</param>
<param name="taskName">task name</param>
<param name="monikerName">the Moniker used to register host object in ROT</param>
<summary>
Register a remote host object for a particular task/target pair.
The remote host object require registered in Running Object Table(ROT) already.
Overwrites any existing host object.
It's caller's responsibly:
To maintain the live cycle of the host object.
Register and unregister from ROT.
Ensure the host object has appropriate COM interface that can be used in task.
</summary>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="SetNodeAffinity">
<MemberSignature Language="C#" Value="public void SetNodeAffinity (string projectFile, Microsoft.Build.Execution.NodeAffinity nodeAffinity);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig instance void SetNodeAffinity(string projectFile, valuetype Microsoft.Build.Execution.NodeAffinity nodeAffinity) cil managed" />
<MemberSignature Language="DocId" Value="M:Microsoft.Build.Execution.HostServices.SetNodeAffinity(System.String,Microsoft.Build.Execution.NodeAffinity)" />
<MemberSignature Language="VB.NET" Value="Public Sub SetNodeAffinity (projectFile As String, nodeAffinity As NodeAffinity)" />
<MemberSignature Language="F#" Value="member this.SetNodeAffinity : string * Microsoft.Build.Execution.NodeAffinity -> unit" Usage="hostServices.SetNodeAffinity (projectFile, nodeAffinity)" />
<MemberSignature Language="C++ CLI" Value="public:
 void SetNodeAffinity(System::String ^ projectFile, Microsoft::Build::Execution::NodeAffinity nodeAffinity);" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Build</AssemblyName>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
<AssemblyVersion>15.1.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Void</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="projectFile" Type="System.String" />
<Parameter Name="nodeAffinity" Type="Microsoft.Build.Execution.NodeAffinity" />
</Parameters>
<Docs>
<param name="projectFile">
The project file. If set to String.Empty, all projects will use the specified affinity. If set to null, all affinities will be cleared.
</param>
<param name="nodeAffinity">The <see cref="T:Microsoft.Build.Execution.NodeAffinity" /> to set.</param>
<summary>
Sets the node affinity for a particular project file.
</summary>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="UnregisterProject">
<MemberSignature Language="C#" Value="public void UnregisterProject (string projectFullPath);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig instance void UnregisterProject(string projectFullPath) cil managed" />
<MemberSignature Language="DocId" Value="M:Microsoft.Build.Execution.HostServices.UnregisterProject(System.String)" />
<MemberSignature Language="VB.NET" Value="Public Sub UnregisterProject (projectFullPath As String)" />
<MemberSignature Language="F#" Value="member this.UnregisterProject : string -> unit" Usage="hostServices.UnregisterProject projectFullPath" />
<MemberSignature Language="C++ CLI" Value="public:
 void UnregisterProject(System::String ^ projectFullPath);" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Build</AssemblyName>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
<AssemblyVersion>15.1.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Void</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="projectFullPath" Type="System.String" />
</Parameters>
<Docs>
<param name="projectFullPath">The path to the project to unregister.</param>
<summary>
Unregister the project's host objects, if any and remove any node affinities associated with it.
</summary>
<remarks>To be added.</remarks>
</Docs>
</Member>
</Members>
</Type>