301 lines
13 KiB
XML
301 lines
13 KiB
XML
|
<?xml version="1.0" encoding="utf-8"?>
|
||
|
|
<Type Name="BuildTask" FullName="Microsoft.Build.BuildEngine.BuildTask">
|
||
|
|
<TypeSignature Language="C#" Value="public class BuildTask" />
|
||
|
|
<AssemblyInfo>
|
||
|
|
<AssemblyName>Microsoft.Build.Engine</AssemblyName>
|
||
|
|
<AssemblyVersion>2.0.0.0</AssemblyVersion>
|
||
|
|
</AssemblyInfo>
|
||
|
|
<Base>
|
||
|
|
<BaseTypeName>System.Object</BaseTypeName>
|
||
|
|
</Base>
|
||
|
|
<Interfaces />
|
||
|
|
<Docs>
|
||
|
|
<remarks>To be added.</remarks>
|
||
|
|
<since version="2.0" />
|
||
|
|
<summary>
|
||
|
|
<attribution license="cc4" from="Microsoft" modified="false" />
|
||
|
|
<para>Represents a <format type="text/html"><a href="d82e2485-e5f0-4936-a357-745bacccc299">Task</a></format> element in a project. </para>
|
||
|
|
</summary>
|
||
|
|
</Docs>
|
||
|
|
<Members>
|
||
|
|
<Member MemberName="AddOutputItem">
|
||
|
|
<MemberSignature Language="C#" Value="public void AddOutputItem (string taskParameter, string itemName);" />
|
||
|
|
<MemberType>Method</MemberType>
|
||
|
|
<ReturnValue>
|
||
|
|
<ReturnType>System.Void</ReturnType>
|
||
|
|
</ReturnValue>
|
||
|
|
<Parameters>
|
||
|
|
<Parameter Name="taskParameter" Type="System.String" />
|
||
|
|
<Parameter Name="itemName" Type="System.String" />
|
||
|
|
</Parameters>
|
||
|
|
<Docs>
|
||
|
|
<remarks>To be added.</remarks>
|
||
|
|
<since version="2.0" />
|
||
|
|
<summary>
|
||
|
|
<attribution license="cc4" from="Microsoft" modified="false" />
|
||
|
|
<para>Adds an <format type="text/html"><a href="34bc7cd1-efd3-4b57-b691-4584eeb6a0e9">Output</a></format> element with the specified <unmanagedCodeEntityReference>TaskParameter</unmanagedCodeEntityReference> and <unmanagedCodeEntityReference>ItemName</unmanagedCodeEntityReference> attributes to the <format type="text/html"><a href="d82e2485-e5f0-4936-a357-745bacccc299">Task</a></format> element.</para>
|
||
|
|
</summary>
|
||
|
|
<param name="taskParameter">
|
||
|
|
<attribution license="cc4" from="Microsoft" modified="false" />The value of the TaskParameter attribute of the Output element.</param>
|
||
|
|
<param name="itemName">
|
||
|
|
<attribution license="cc4" from="Microsoft" modified="false" />The value of the ItemName attribute of the Output element.</param>
|
||
|
|
</Docs>
|
||
|
|
<AssemblyInfo>
|
||
|
|
<AssemblyVersion>2.0.0.0</AssemblyVersion>
|
||
|
|
</AssemblyInfo>
|
||
|
|
</Member>
|
||
|
|
<Member MemberName="AddOutputProperty">
|
||
|
|
<MemberSignature Language="C#" Value="public void AddOutputProperty (string taskParameter, string propertyName);" />
|
||
|
|
<MemberType>Method</MemberType>
|
||
|
|
<ReturnValue>
|
||
|
|
<ReturnType>System.Void</ReturnType>
|
||
|
|
</ReturnValue>
|
||
|
|
<Parameters>
|
||
|
|
<Parameter Name="taskParameter" Type="System.String" />
|
||
|
|
<Parameter Name="propertyName" Type="System.String" />
|
||
|
|
</Parameters>
|
||
|
|
<Docs>
|
||
|
|
<remarks>To be added.</remarks>
|
||
|
|
<since version="2.0" />
|
||
|
|
<summary>
|
||
|
|
<attribution license="cc4" from="Microsoft" modified="false" />
|
||
|
|
<para>Adds an <format type="text/html"><a href="34bc7cd1-efd3-4b57-b691-4584eeb6a0e9">Output</a></format> element with the specified <unmanagedCodeEntityReference>TaskParameter</unmanagedCodeEntityReference> and <unmanagedCodeEntityReference>PropertyName</unmanagedCodeEntityReference> attributes to the <format type="text/html"><a href="d82e2485-e5f0-4936-a357-745bacccc299">Task</a></format> element.</para>
|
||
|
|
</summary>
|
||
|
|
<param name="taskParameter">
|
||
|
|
<attribution license="cc4" from="Microsoft" modified="false" />The value of the TaskParameter attribute of the Output element.</param>
|
||
|
|
<param name="propertyName">
|
||
|
|
<attribution license="cc4" from="Microsoft" modified="false" />The value of the PropertyName attribute of the Output element.</param>
|
||
|
|
</Docs>
|
||
|
|
<AssemblyInfo>
|
||
|
|
<AssemblyVersion>2.0.0.0</AssemblyVersion>
|
||
|
|
</AssemblyInfo>
|
||
|
|
</Member>
|
||
|
|
<Member MemberName="Condition">
|
||
|
|
<MemberSignature Language="C#" Value="public string Condition { set; get; }" />
|
||
|
|
<MemberType>Property</MemberType>
|
||
|
|
<ReturnValue>
|
||
|
|
<ReturnType>System.String</ReturnType>
|
||
|
|
</ReturnValue>
|
||
|
|
<Docs>
|
||
|
|
<value>To be added.</value>
|
||
|
|
<remarks>To be added.</remarks>
|
||
|
|
<since version="2.0" />
|
||
|
|
<summary>
|
||
|
|
<attribution license="cc4" from="Microsoft" modified="false" />
|
||
|
|
<para>Gets or sets the <unmanagedCodeEntityReference>Condition</unmanagedCodeEntityReference> attribute value of the <format type="text/html"><a href="d82e2485-e5f0-4936-a357-745bacccc299">Task</a></format> element.</para>
|
||
|
|
</summary>
|
||
|
|
</Docs>
|
||
|
|
<AssemblyInfo>
|
||
|
|
<AssemblyVersion>2.0.0.0</AssemblyVersion>
|
||
|
|
</AssemblyInfo>
|
||
|
|
</Member>
|
||
|
|
<Member MemberName="ContinueOnError">
|
||
|
|
<MemberSignature Language="C#" Value="public bool ContinueOnError { set; get; }" />
|
||
|
|
<MemberType>Property</MemberType>
|
||
|
|
<ReturnValue>
|
||
|
|
<ReturnType>System.Boolean</ReturnType>
|
||
|
|
</ReturnValue>
|
||
|
|
<Docs>
|
||
|
|
<value>To be added.</value>
|
||
|
|
<remarks>To be added.</remarks>
|
||
|
|
<since version="2.0" />
|
||
|
|
<summary>
|
||
|
|
<attribution license="cc4" from="Microsoft" modified="false" />
|
||
|
|
<para>Gets or sets the <unmanagedCodeEntityReference>ContinueOnError</unmanagedCodeEntityReference> attribute value of the <format type="text/html"><a href="d82e2485-e5f0-4936-a357-745bacccc299">Task</a></format> element.</para>
|
||
|
|
</summary>
|
||
|
|
</Docs>
|
||
|
|
<AssemblyInfo>
|
||
|
|
<AssemblyVersion>2.0.0.0</AssemblyVersion>
|
||
|
|
</AssemblyInfo>
|
||
|
|
</Member>
|
||
|
|
<Member MemberName="Execute">
|
||
|
|
<MemberSignature Language="C#" Value="public bool Execute ();" />
|
||
|
|
<MemberType>Method</MemberType>
|
||
|
|
<ReturnValue>
|
||
|
|
<ReturnType>System.Boolean</ReturnType>
|
||
|
|
</ReturnValue>
|
||
|
|
<Parameters />
|
||
|
|
<Docs>
|
||
|
|
<remarks>To be added.</remarks>
|
||
|
|
<since version="2.0" />
|
||
|
|
<summary>
|
||
|
|
<attribution license="cc4" from="Microsoft" modified="false" />
|
||
|
|
<para>Runs the task represented by this <see cref="T:Microsoft.Build.BuildEngine.BuildTask" /> object.</para>
|
||
|
|
</summary>
|
||
|
|
<returns>
|
||
|
|
<attribution license="cc4" from="Microsoft" modified="false" />
|
||
|
|
<para>true if the method was successful; otherwise, false.</para>
|
||
|
|
</returns>
|
||
|
|
</Docs>
|
||
|
|
<AssemblyInfo>
|
||
|
|
<AssemblyVersion>2.0.0.0</AssemblyVersion>
|
||
|
|
</AssemblyInfo>
|
||
|
|
</Member>
|
||
|
|
<Member MemberName="GetParameterNames">
|
||
|
|
<MemberSignature Language="C#" Value="public string[] GetParameterNames ();" />
|
||
|
|
<MemberType>Method</MemberType>
|
||
|
|
<ReturnValue>
|
||
|
|
<ReturnType>System.String[]</ReturnType>
|
||
|
|
</ReturnValue>
|
||
|
|
<Parameters />
|
||
|
|
<Docs>
|
||
|
|
<since version="2.0" />
|
||
|
|
<remarks>
|
||
|
|
<attribution license="cc4" from="Microsoft" modified="false" />
|
||
|
|
<para>The returned array excludes the <unmanagedCodeEntityReference>Condition</unmanagedCodeEntityReference> and <unmanagedCodeEntityReference>ContinueOnError</unmanagedCodeEntityReference> parameters.</para>
|
||
|
|
<para>If no parameters are passed to the task, this method returns an empty array.</para>
|
||
|
|
</remarks>
|
||
|
|
<summary>
|
||
|
|
<attribution license="cc4" from="Microsoft" modified="false" />
|
||
|
|
<para>Gets an array containing the parameter names passed to the task.</para>
|
||
|
|
</summary>
|
||
|
|
<returns>
|
||
|
|
<attribution license="cc4" from="Microsoft" modified="false" />
|
||
|
|
<para>An array containing the parameter names passed to the task.</para>
|
||
|
|
</returns>
|
||
|
|
</Docs>
|
||
|
|
<AssemblyInfo>
|
||
|
|
<AssemblyVersion>2.0.0.0</AssemblyVersion>
|
||
|
|
</AssemblyInfo>
|
||
|
|
</Member>
|
||
|
|
<Member MemberName="GetParameterValue">
|
||
|
|
<MemberSignature Language="C#" Value="public string GetParameterValue (string attributeName);" />
|
||
|
|
<MemberType>Method</MemberType>
|
||
|
|
<ReturnValue>
|
||
|
|
<ReturnType>System.String</ReturnType>
|
||
|
|
</ReturnValue>
|
||
|
|
<Parameters>
|
||
|
|
<Parameter Name="attributeName" Type="System.String" />
|
||
|
|
</Parameters>
|
||
|
|
<Docs>
|
||
|
|
<remarks>To be added.</remarks>
|
||
|
|
<since version="2.0" />
|
||
|
|
<summary>
|
||
|
|
<attribution license="cc4" from="Microsoft" modified="false" />
|
||
|
|
<para>Gets the value of the specified task parameter.</para>
|
||
|
|
</summary>
|
||
|
|
<returns>
|
||
|
|
<attribution license="cc4" from="Microsoft" modified="false" />
|
||
|
|
<para>The value of the specified task parameter.</para>
|
||
|
|
</returns>
|
||
|
|
<param name="attributeName">
|
||
|
|
<attribution license="cc4" from="Microsoft" modified="false" />The parameter name.</param>
|
||
|
|
</Docs>
|
||
|
|
<AssemblyInfo>
|
||
|
|
<AssemblyVersion>2.0.0.0</AssemblyVersion>
|
||
|
|
</AssemblyInfo>
|
||
|
|
</Member>
|
||
|
|
<Member MemberName="HostObject">
|
||
|
|
<MemberSignature Language="C#" Value="public Microsoft.Build.Framework.ITaskHost HostObject { set; get; }" />
|
||
|
|
<MemberType>Property</MemberType>
|
||
|
|
<ReturnValue>
|
||
|
|
<ReturnType>Microsoft.Build.Framework.ITaskHost</ReturnType>
|
||
|
|
</ReturnValue>
|
||
|
|
<Docs>
|
||
|
|
<value>To be added.</value>
|
||
|
|
<remarks>To be added.</remarks>
|
||
|
|
<since version="2.0" />
|
||
|
|
<summary>
|
||
|
|
<attribution license="cc4" from="Microsoft" modified="false" />
|
||
|
|
<para>Gets or sets the host object associated with the task.</para>
|
||
|
|
</summary>
|
||
|
|
</Docs>
|
||
|
|
<AssemblyInfo>
|
||
|
|
<AssemblyVersion>2.0.0.0</AssemblyVersion>
|
||
|
|
</AssemblyInfo>
|
||
|
|
</Member>
|
||
|
|
<Member MemberName="Name">
|
||
|
|
<MemberSignature Language="C#" Value="public string Name { get; }" />
|
||
|
|
<MemberType>Property</MemberType>
|
||
|
|
<ReturnValue>
|
||
|
|
<ReturnType>System.String</ReturnType>
|
||
|
|
</ReturnValue>
|
||
|
|
<Docs>
|
||
|
|
<value>To be added.</value>
|
||
|
|
<remarks>To be added.</remarks>
|
||
|
|
<since version="2.0" />
|
||
|
|
<summary>
|
||
|
|
<attribution license="cc4" from="Microsoft" modified="false" />
|
||
|
|
<para>Gets the task name.</para>
|
||
|
|
</summary>
|
||
|
|
</Docs>
|
||
|
|
<AssemblyInfo>
|
||
|
|
<AssemblyVersion>2.0.0.0</AssemblyVersion>
|
||
|
|
</AssemblyInfo>
|
||
|
|
</Member>
|
||
|
|
<Member MemberName="SetParameterValue">
|
||
|
|
<MemberSignature Language="C#" Value="public void SetParameterValue (string parameterName, string parameterValue);" />
|
||
|
|
<MemberType>Method</MemberType>
|
||
|
|
<ReturnValue>
|
||
|
|
<ReturnType>System.Void</ReturnType>
|
||
|
|
</ReturnValue>
|
||
|
|
<Parameters>
|
||
|
|
<Parameter Name="parameterName" Type="System.String" />
|
||
|
|
<Parameter Name="parameterValue" Type="System.String" />
|
||
|
|
</Parameters>
|
||
|
|
<Docs>
|
||
|
|
<remarks>To be added.</remarks>
|
||
|
|
<since version="2.0" />
|
||
|
|
<summary>
|
||
|
|
<attribution license="cc4" from="Microsoft" modified="false" />
|
||
|
|
<para>Sets the value of the specified task parameter.</para>
|
||
|
|
</summary>
|
||
|
|
<param name="parameterName">
|
||
|
|
<attribution license="cc4" from="Microsoft" modified="false" />The parameter name to set.</param>
|
||
|
|
<param name="parameterValue">
|
||
|
|
<attribution license="cc4" from="Microsoft" modified="false" />The value to assign to <paramref name="parameterName" />.</param>
|
||
|
|
</Docs>
|
||
|
|
<AssemblyInfo>
|
||
|
|
<AssemblyVersion>2.0.0.0</AssemblyVersion>
|
||
|
|
</AssemblyInfo>
|
||
|
|
</Member>
|
||
|
|
<Member MemberName="SetParameterValue">
|
||
|
|
<MemberSignature Language="C#" Value="public void SetParameterValue (string parameterName, string parameterValue, bool treatParameterValueAsLiteral);" />
|
||
|
|
<MemberType>Method</MemberType>
|
||
|
|
<ReturnValue>
|
||
|
|
<ReturnType>System.Void</ReturnType>
|
||
|
|
</ReturnValue>
|
||
|
|
<Parameters>
|
||
|
|
<Parameter Name="parameterName" Type="System.String" />
|
||
|
|
<Parameter Name="parameterValue" Type="System.String" />
|
||
|
|
<Parameter Name="treatParameterValueAsLiteral" Type="System.Boolean" />
|
||
|
|
</Parameters>
|
||
|
|
<Docs>
|
||
|
|
<remarks>To be added.</remarks>
|
||
|
|
<since version="2.0" />
|
||
|
|
<summary>
|
||
|
|
<attribution license="cc4" from="Microsoft" modified="false" />
|
||
|
|
<para>Sets the value of the specified task parameter.</para>
|
||
|
|
</summary>
|
||
|
|
<param name="parameterName">
|
||
|
|
<attribution license="cc4" from="Microsoft" modified="false" />The parameter name to set.</param>
|
||
|
|
<param name="parameterValue">
|
||
|
|
<attribution license="cc4" from="Microsoft" modified="false" />The value to assign to <paramref name="parameterName" />.</param>
|
||
|
|
<param name="treatParameterValueAsLiteral">
|
||
|
|
<attribution license="cc4" from="Microsoft" modified="false" />true to treat <paramref name="parameterValue" /> as a literal value; otherwise, false.</param>
|
||
|
|
</Docs>
|
||
|
|
<AssemblyInfo>
|
||
|
|
<AssemblyVersion>2.0.0.0</AssemblyVersion>
|
||
|
|
</AssemblyInfo>
|
||
|
|
</Member>
|
||
|
|
<Member MemberName="Type">
|
||
|
|
<MemberSignature Language="C#" Value="public Type Type { get; }" />
|
||
|
|
<MemberType>Property</MemberType>
|
||
|
|
<ReturnValue>
|
||
|
|
<ReturnType>System.Type</ReturnType>
|
||
|
|
</ReturnValue>
|
||
|
|
<Docs>
|
||
|
|
<value>To be added.</value>
|
||
|
|
<remarks>To be added.</remarks>
|
||
|
|
<since version="2.0" />
|
||
|
|
<summary>
|
||
|
|
<attribution license="cc4" from="Microsoft" modified="false" />
|
||
|
|
<para>Gets the <see cref="T:System.Type" /> of the class that implements the task.</para>
|
||
|
|
</summary>
|
||
|
|
</Docs>
|
||
|
|
<AssemblyInfo>
|
||
|
|
<AssemblyVersion>2.0.0.0</AssemblyVersion>
|
||
|
|
</AssemblyInfo>
|
||
|
|
</Member>
|
||
|
|
</Members>
|
||
|
|
</Type>
|