You've already forked linux-packaging-mono
1305 lines
65 KiB
XML
1305 lines
65 KiB
XML
<?xml version="1.0" encoding="utf-8"?>
|
|
<Type Name="TaskLoggingHelper" FullName="Microsoft.Build.Utilities.TaskLoggingHelper">
|
|
<TypeSignature Language="C#" Value="public class TaskLoggingHelper : MarshalByRefObject" />
|
|
<AssemblyInfo>
|
|
<AssemblyName>Microsoft.Build.Utilities</AssemblyName>
|
|
<AssemblyVersion>2.0.0.0</AssemblyVersion>
|
|
</AssemblyInfo>
|
|
<Base>
|
|
<BaseTypeName>System.MarshalByRefObject</BaseTypeName>
|
|
</Base>
|
|
<Interfaces />
|
|
<Docs>
|
|
<remarks>To be added.</remarks>
|
|
<since version="2.0" />
|
|
<summary>
|
|
<attribution license="cc4" from="Microsoft" modified="false" />
|
|
<para>Provides helper logging methods used by tasks.</para>
|
|
</summary>
|
|
</Docs>
|
|
<Members>
|
|
<Member MemberName=".ctor">
|
|
<MemberSignature Language="C#" Value="public TaskLoggingHelper (Microsoft.Build.Framework.ITask taskInstance);" />
|
|
<MemberType>Constructor</MemberType>
|
|
<Parameters>
|
|
<Parameter Name="taskInstance" Type="Microsoft.Build.Framework.ITask" />
|
|
</Parameters>
|
|
<Docs>
|
|
<remarks>To be added.</remarks>
|
|
<since version="2.0" />
|
|
<summary>
|
|
<attribution license="cc4" from="Microsoft" modified="false" />
|
|
<para>Initializes a new instance of the <see cref="T:Microsoft.Build.Utilities.TaskLoggingHelper" /> class and associates it with the specified task instance.</para>
|
|
</summary>
|
|
<param name="taskInstance">
|
|
<attribution license="cc4" from="Microsoft" modified="false" />The task containing an instance of this task.</param>
|
|
</Docs>
|
|
<AssemblyInfo>
|
|
<AssemblyVersion>2.0.0.0</AssemblyVersion>
|
|
</AssemblyInfo>
|
|
</Member>
|
|
<Member MemberName="BuildEngine">
|
|
<MemberSignature Language="C#" Value="protected Microsoft.Build.Framework.IBuildEngine BuildEngine { get; }" />
|
|
<MemberType>Property</MemberType>
|
|
<ReturnValue>
|
|
<ReturnType>Microsoft.Build.Framework.IBuildEngine</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 build engine that is associated with the task.</para>
|
|
</summary>
|
|
</Docs>
|
|
<AssemblyInfo>
|
|
<AssemblyVersion>2.0.0.0</AssemblyVersion>
|
|
</AssemblyInfo>
|
|
</Member>
|
|
<Member MemberName="ExtractMessageCode">
|
|
<MemberSignature Language="C#" Value="public string ExtractMessageCode (string message, out string messageWithoutCodePrefix);" />
|
|
<MemberType>Method</MemberType>
|
|
<ReturnValue>
|
|
<ReturnType>System.String</ReturnType>
|
|
</ReturnValue>
|
|
<Parameters>
|
|
<Parameter Name="message" Type="System.String" />
|
|
<Parameter Name="messageWithoutCodePrefix" Type="System.String&" RefType="out" />
|
|
</Parameters>
|
|
<Docs>
|
|
<param name="message">To be added.</param>
|
|
<param name="messageWithoutCodePrefix">To be added.</param>
|
|
<summary>To be added.</summary>
|
|
<returns>To be added.</returns>
|
|
<remarks>To be added.</remarks>
|
|
<since version="2.0" />
|
|
</Docs>
|
|
<AssemblyInfo>
|
|
<AssemblyVersion>2.0.0.0</AssemblyVersion>
|
|
</AssemblyInfo>
|
|
</Member>
|
|
<Member MemberName="FormatResourceString">
|
|
<MemberSignature Language="C#" Value="public virtual string FormatResourceString (string resourceName, object[] args);" />
|
|
<MemberType>Method</MemberType>
|
|
<ReturnValue>
|
|
<ReturnType>System.String</ReturnType>
|
|
</ReturnValue>
|
|
<Parameters>
|
|
<Parameter Name="resourceName" Type="System.String" />
|
|
<Parameter Name="args" Type="System.Object[]">
|
|
<Attributes>
|
|
<Attribute>
|
|
<AttributeName>System.ParamArray</AttributeName>
|
|
</Attribute>
|
|
</Attributes>
|
|
</Parameter>
|
|
</Parameters>
|
|
<Docs>
|
|
<since version="2.0" />
|
|
<remarks>
|
|
<attribution license="cc4" from="Microsoft" modified="false" />
|
|
<para>The culture of the current thread is used for formatting.</para>
|
|
<para>This method requires the owner task to have registered its resources with either the <see cref="T:Microsoft.Build.Utilities.Task" /> base class constructor, or the <see cref="P:Microsoft.Build.Utilities.Task.TaskResources" /> property.</para>
|
|
</remarks>
|
|
<summary>
|
|
<attribution license="cc4" from="Microsoft" modified="false" />
|
|
<para>Loads the specified resource string and optionally formats it using the given arguments.</para>
|
|
</summary>
|
|
<returns>
|
|
<attribution license="cc4" from="Microsoft" modified="false" />
|
|
<para>The formatted string.</para>
|
|
</returns>
|
|
<param name="resourceName">
|
|
<attribution license="cc4" from="Microsoft" modified="false" />The name of the string resource to load.</param>
|
|
<param name="args">
|
|
<attribution license="cc4" from="Microsoft" modified="false" />Optional arguments for formatting the loaded string.</param>
|
|
</Docs>
|
|
<AssemblyInfo>
|
|
<AssemblyVersion>2.0.0.0</AssemblyVersion>
|
|
</AssemblyInfo>
|
|
</Member>
|
|
<Member MemberName="FormatString">
|
|
<MemberSignature Language="C#" Value="public virtual string FormatString (string unformatted, object[] args);" />
|
|
<MemberType>Method</MemberType>
|
|
<ReturnValue>
|
|
<ReturnType>System.String</ReturnType>
|
|
</ReturnValue>
|
|
<Parameters>
|
|
<Parameter Name="unformatted" Type="System.String" />
|
|
<Parameter Name="args" Type="System.Object[]">
|
|
<Attributes>
|
|
<Attribute>
|
|
<AttributeName>System.ParamArray</AttributeName>
|
|
</Attribute>
|
|
</Attributes>
|
|
</Parameter>
|
|
</Parameters>
|
|
<Docs>
|
|
<since version="2.0" />
|
|
<remarks>
|
|
<attribution license="cc4" from="Microsoft" modified="false" />
|
|
<para>The culture of the current thread is used for formatting.</para>
|
|
</remarks>
|
|
<summary>
|
|
<attribution license="cc4" from="Microsoft" modified="false" />
|
|
<para>Formats the given string using the given arguments.</para>
|
|
</summary>
|
|
<returns>
|
|
<attribution license="cc4" from="Microsoft" modified="false" />
|
|
<para>The formatted string.</para>
|
|
</returns>
|
|
<param name="unformatted">
|
|
<attribution license="cc4" from="Microsoft" modified="false" />The string to format.</param>
|
|
<param name="args">
|
|
<attribution license="cc4" from="Microsoft" modified="false" />Arguments for formatting.</param>
|
|
</Docs>
|
|
<AssemblyInfo>
|
|
<AssemblyVersion>2.0.0.0</AssemblyVersion>
|
|
</AssemblyInfo>
|
|
</Member>
|
|
<Member MemberName="HasLoggedErrors">
|
|
<MemberSignature Language="C#" Value="public bool HasLoggedErrors { 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 a value that indicates whether the task has logged any errors through this logging helper object.</para>
|
|
</summary>
|
|
</Docs>
|
|
<AssemblyInfo>
|
|
<AssemblyVersion>2.0.0.0</AssemblyVersion>
|
|
</AssemblyInfo>
|
|
</Member>
|
|
<Member MemberName="HelpKeywordPrefix">
|
|
<MemberSignature Language="C#" Value="public string HelpKeywordPrefix { set; get; }" />
|
|
<MemberType>Property</MemberType>
|
|
<ReturnValue>
|
|
<ReturnType>System.String</ReturnType>
|
|
</ReturnValue>
|
|
<Docs>
|
|
<value>To be added.</value>
|
|
<since version="2.0" />
|
|
<remarks>
|
|
<attribution license="cc4" from="Microsoft" modified="false" />
|
|
<para>If a task does not have Help keywords associated with its messages, it can ignore this property or set it to null. If this property is set to an empty <see cref="T:System.String" />, resource names will be used verbatim as Help keywords.</para>
|
|
</remarks>
|
|
<summary>
|
|
<attribution license="cc4" from="Microsoft" modified="false" />
|
|
<para>Gets or sets the prefix used to compose Help keywords from resource names.</para>
|
|
</summary>
|
|
</Docs>
|
|
<AssemblyInfo>
|
|
<AssemblyVersion>2.0.0.0</AssemblyVersion>
|
|
</AssemblyInfo>
|
|
</Member>
|
|
<Member MemberName="LogCommandLine">
|
|
<MemberSignature Language="C#" Value="public void LogCommandLine (string commandLine);" />
|
|
<MemberType>Method</MemberType>
|
|
<ReturnValue>
|
|
<ReturnType>System.Void</ReturnType>
|
|
</ReturnValue>
|
|
<Parameters>
|
|
<Parameter Name="commandLine" Type="System.String" />
|
|
</Parameters>
|
|
<Docs>
|
|
<since version="2.0" />
|
|
<remarks>
|
|
<attribution license="cc4" from="Microsoft" modified="false" />
|
|
<para>This method is not thread-safe.</para>
|
|
</remarks>
|
|
<summary>
|
|
<attribution license="cc4" from="Microsoft" modified="false" />
|
|
<para>Logs the command line for an underlying tool, executable file, or shell command of a task.</para>
|
|
</summary>
|
|
<param name="commandLine">
|
|
<attribution license="cc4" from="Microsoft" modified="false" />The command line string.</param>
|
|
</Docs>
|
|
<AssemblyInfo>
|
|
<AssemblyVersion>2.0.0.0</AssemblyVersion>
|
|
</AssemblyInfo>
|
|
</Member>
|
|
<Member MemberName="LogCommandLine">
|
|
<MemberSignature Language="C#" Value="public void LogCommandLine (Microsoft.Build.Framework.MessageImportance importance, string commandLine);" />
|
|
<MemberType>Method</MemberType>
|
|
<ReturnValue>
|
|
<ReturnType>System.Void</ReturnType>
|
|
</ReturnValue>
|
|
<Parameters>
|
|
<Parameter Name="importance" Type="Microsoft.Build.Framework.MessageImportance" />
|
|
<Parameter Name="commandLine" Type="System.String" />
|
|
</Parameters>
|
|
<Docs>
|
|
<since version="2.0" />
|
|
<remarks>
|
|
<attribution license="cc4" from="Microsoft" modified="false" />
|
|
<para>This method is not thread-safe.</para>
|
|
</remarks>
|
|
<summary>
|
|
<attribution license="cc4" from="Microsoft" modified="false" />
|
|
<para>Logs the command line for an underlying tool, executable file, or shell command of a task using the specified importance level.</para>
|
|
</summary>
|
|
<param name="importance">
|
|
<attribution license="cc4" from="Microsoft" modified="false" />One of the values of <see cref="T:Microsoft.Build.Framework.MessageImportance" /> that indicates the importance level of the command line.</param>
|
|
<param name="commandLine">
|
|
<attribution license="cc4" from="Microsoft" modified="false" />The command line string.</param>
|
|
</Docs>
|
|
<AssemblyInfo>
|
|
<AssemblyVersion>2.0.0.0</AssemblyVersion>
|
|
</AssemblyInfo>
|
|
</Member>
|
|
<Member MemberName="LogError">
|
|
<MemberSignature Language="C#" Value="public void LogError (string message, object[] messageArgs);" />
|
|
<MemberType>Method</MemberType>
|
|
<ReturnValue>
|
|
<ReturnType>System.Void</ReturnType>
|
|
</ReturnValue>
|
|
<Parameters>
|
|
<Parameter Name="message" Type="System.String" />
|
|
<Parameter Name="messageArgs" Type="System.Object[]">
|
|
<Attributes>
|
|
<Attribute>
|
|
<AttributeName>System.ParamArray</AttributeName>
|
|
</Attribute>
|
|
</Attributes>
|
|
</Parameter>
|
|
</Parameters>
|
|
<Docs>
|
|
<since version="2.0" />
|
|
<remarks>
|
|
<attribution license="cc4" from="Microsoft" modified="false" />
|
|
<para>This method is not thread-safe.</para>
|
|
</remarks>
|
|
<summary>
|
|
<attribution license="cc4" from="Microsoft" modified="false" />
|
|
<para>Logs an error with the specified message.</para>
|
|
</summary>
|
|
<param name="message">
|
|
<attribution license="cc4" from="Microsoft" modified="false" />The message.</param>
|
|
<param name="messageArgs">
|
|
<attribution license="cc4" from="Microsoft" modified="false" />Optional arguments for formatting the message string.</param>
|
|
</Docs>
|
|
<AssemblyInfo>
|
|
<AssemblyVersion>2.0.0.0</AssemblyVersion>
|
|
</AssemblyInfo>
|
|
</Member>
|
|
<Member MemberName="LogError">
|
|
<MemberSignature Language="C#" Value="public void LogError (string subcategory, string errorCode, string helpKeyword, string file, int lineNumber, int columnNumber, int endLineNumber, int endColumnNumber, string message, object[] messageArgs);" />
|
|
<MemberType>Method</MemberType>
|
|
<ReturnValue>
|
|
<ReturnType>System.Void</ReturnType>
|
|
</ReturnValue>
|
|
<Parameters>
|
|
<Parameter Name="subcategory" Type="System.String" />
|
|
<Parameter Name="errorCode" Type="System.String" />
|
|
<Parameter Name="helpKeyword" Type="System.String" />
|
|
<Parameter Name="file" Type="System.String" />
|
|
<Parameter Name="lineNumber" Type="System.Int32" />
|
|
<Parameter Name="columnNumber" Type="System.Int32" />
|
|
<Parameter Name="endLineNumber" Type="System.Int32" />
|
|
<Parameter Name="endColumnNumber" Type="System.Int32" />
|
|
<Parameter Name="message" Type="System.String" />
|
|
<Parameter Name="messageArgs" Type="System.Object[]">
|
|
<Attributes>
|
|
<Attribute>
|
|
<AttributeName>System.ParamArray</AttributeName>
|
|
</Attribute>
|
|
</Attributes>
|
|
</Parameter>
|
|
</Parameters>
|
|
<Docs>
|
|
<since version="2.0" />
|
|
<remarks>
|
|
<attribution license="cc4" from="Microsoft" modified="false" />
|
|
<para>The parameters <paramref name="subCategory" />, <paramref name="errorCode" />, <paramref name="helpKeyword" />, and <paramref name="file" /> can be null.</para>
|
|
<para>The parameters <paramref name="lineNumber" />, <paramref name="columnNumber" />, <paramref name="endLineNumber" />, and <paramref name="endColumnNumber" /> should be set to <math>0</math> if they are not available.</para>
|
|
</remarks>
|
|
<summary>
|
|
<attribution license="cc4" from="Microsoft" modified="false" />
|
|
<para>Logs an error using the specified message and other error details.</para>
|
|
</summary>
|
|
<param name="subcategory">
|
|
<attribution license="cc4" from="Microsoft" modified="false" />The description of the error type.</param>
|
|
<param name="errorCode">
|
|
<attribution license="cc4" from="Microsoft" modified="false" />The error code.</param>
|
|
<param name="helpKeyword">
|
|
<attribution license="cc4" from="Microsoft" modified="false" />The Help keyword to associate with the error.</param>
|
|
<param name="file">
|
|
<attribution license="cc4" from="Microsoft" modified="false" />The path to the file containing the error.</param>
|
|
<param name="lineNumber">
|
|
<attribution license="cc4" from="Microsoft" modified="false" />The line in the file where the error occurs.</param>
|
|
<param name="columnNumber">
|
|
<attribution license="cc4" from="Microsoft" modified="false" />The column in the file where the error occurs.</param>
|
|
<param name="endLineNumber">
|
|
<attribution license="cc4" from="Microsoft" modified="false" />The end line in the file where the error occurs.</param>
|
|
<param name="endColumnNumber">
|
|
<attribution license="cc4" from="Microsoft" modified="false" />The end column in the file where the error occurs.</param>
|
|
<param name="message">
|
|
<attribution license="cc4" from="Microsoft" modified="false" />The message.</param>
|
|
<param name="messageArgs">
|
|
<attribution license="cc4" from="Microsoft" modified="false" />Optional arguments for formatting the message string.</param>
|
|
</Docs>
|
|
<AssemblyInfo>
|
|
<AssemblyVersion>2.0.0.0</AssemblyVersion>
|
|
</AssemblyInfo>
|
|
</Member>
|
|
<Member MemberName="LogErrorFromException">
|
|
<MemberSignature Language="C#" Value="public void LogErrorFromException (Exception e);" />
|
|
<MemberType>Method</MemberType>
|
|
<ReturnValue>
|
|
<ReturnType>System.Void</ReturnType>
|
|
</ReturnValue>
|
|
<Parameters>
|
|
<Parameter Name="e" Type="System.Exception" />
|
|
</Parameters>
|
|
<Docs>
|
|
<param name="e">To be added.</param>
|
|
<since version="2.0" />
|
|
<remarks>
|
|
<attribution license="cc4" from="Microsoft" modified="false" />
|
|
<para>No call stack will be shown.</para>
|
|
</remarks>
|
|
<summary>
|
|
<attribution license="cc4" from="Microsoft" modified="false" />
|
|
<para>Logs an error using the message from the given exception.</para>
|
|
</summary>
|
|
</Docs>
|
|
<AssemblyInfo>
|
|
<AssemblyVersion>2.0.0.0</AssemblyVersion>
|
|
</AssemblyInfo>
|
|
</Member>
|
|
<Member MemberName="LogErrorFromException">
|
|
<MemberSignature Language="C#" Value="public void LogErrorFromException (Exception e, bool showStackTrace);" />
|
|
<MemberType>Method</MemberType>
|
|
<ReturnValue>
|
|
<ReturnType>System.Void</ReturnType>
|
|
</ReturnValue>
|
|
<Parameters>
|
|
<Parameter Name="e" Type="System.Exception" />
|
|
<Parameter Name="showStackTrace" Type="System.Boolean" />
|
|
</Parameters>
|
|
<Docs>
|
|
<param name="e">To be added.</param>
|
|
<since version="2.0" />
|
|
<remarks>
|
|
<attribution license="cc4" from="Microsoft" modified="false" />
|
|
<para>This method is not thread-safe.</para>
|
|
</remarks>
|
|
<summary>
|
|
<attribution license="cc4" from="Microsoft" modified="false" />
|
|
<para>Logs an error using the message, and optionally the stack trace, from the given exception.</para>
|
|
</summary>
|
|
<param name="showStackTrace">
|
|
<attribution license="cc4" from="Microsoft" modified="false" />true to include the stack trace in the log; otherwise, false.</param>
|
|
</Docs>
|
|
<AssemblyInfo>
|
|
<AssemblyVersion>2.0.0.0</AssemblyVersion>
|
|
</AssemblyInfo>
|
|
</Member>
|
|
<Member MemberName="LogErrorFromResources">
|
|
<MemberSignature Language="C#" Value="public void LogErrorFromResources (string messageResourceName, object[] messageArgs);" />
|
|
<MemberType>Method</MemberType>
|
|
<ReturnValue>
|
|
<ReturnType>System.Void</ReturnType>
|
|
</ReturnValue>
|
|
<Parameters>
|
|
<Parameter Name="messageResourceName" Type="System.String" />
|
|
<Parameter Name="messageArgs" Type="System.Object[]">
|
|
<Attributes>
|
|
<Attribute>
|
|
<AttributeName>System.ParamArray</AttributeName>
|
|
</Attribute>
|
|
</Attributes>
|
|
</Parameter>
|
|
</Parameters>
|
|
<Docs>
|
|
<since version="2.0" />
|
|
<remarks>
|
|
<attribution license="cc4" from="Microsoft" modified="false" />
|
|
<para>This method is not thread-safe.</para>
|
|
</remarks>
|
|
<summary>
|
|
<attribution license="cc4" from="Microsoft" modified="false" />
|
|
<para>Logs an error using the specified resource string.</para>
|
|
</summary>
|
|
<param name="messageResourceName">
|
|
<attribution license="cc4" from="Microsoft" modified="false" />The name of the string resource to load.</param>
|
|
<param name="messageArgs">
|
|
<attribution license="cc4" from="Microsoft" modified="false" />The arguments for formatting the loaded string.</param>
|
|
</Docs>
|
|
<AssemblyInfo>
|
|
<AssemblyVersion>2.0.0.0</AssemblyVersion>
|
|
</AssemblyInfo>
|
|
</Member>
|
|
<Member MemberName="LogErrorFromResources">
|
|
<MemberSignature Language="C#" Value="public void LogErrorFromResources (string subcategoryResourceName, string errorCode, string helpKeyword, string file, int lineNumber, int columnNumber, int endLineNumber, int endColumnNumber, string messageResourceName, object[] messageArgs);" />
|
|
<MemberType>Method</MemberType>
|
|
<ReturnValue>
|
|
<ReturnType>System.Void</ReturnType>
|
|
</ReturnValue>
|
|
<Parameters>
|
|
<Parameter Name="subcategoryResourceName" Type="System.String" />
|
|
<Parameter Name="errorCode" Type="System.String" />
|
|
<Parameter Name="helpKeyword" Type="System.String" />
|
|
<Parameter Name="file" Type="System.String" />
|
|
<Parameter Name="lineNumber" Type="System.Int32" />
|
|
<Parameter Name="columnNumber" Type="System.Int32" />
|
|
<Parameter Name="endLineNumber" Type="System.Int32" />
|
|
<Parameter Name="endColumnNumber" Type="System.Int32" />
|
|
<Parameter Name="messageResourceName" Type="System.String" />
|
|
<Parameter Name="messageArgs" Type="System.Object[]">
|
|
<Attributes>
|
|
<Attribute>
|
|
<AttributeName>System.ParamArray</AttributeName>
|
|
</Attribute>
|
|
</Attributes>
|
|
</Parameter>
|
|
</Parameters>
|
|
<Docs>
|
|
<since version="2.0" />
|
|
<remarks>
|
|
<attribution license="cc4" from="Microsoft" modified="false" />
|
|
<para>The parameters <paramref name="subCategoryResourceName" />, <paramref name="errorCode" />, <paramref name="helpKeyword" />, and <paramref name="file" /> can be null.</para>
|
|
<para>The parameters <paramref name="lineNumber" />, <paramref name="columnNumber" />, <paramref name="endLineNumber" />, and <paramref name="endColumnNumber" /> should be set to <math>0</math> if they are not available.</para>
|
|
</remarks>
|
|
<summary>
|
|
<attribution license="cc4" from="Microsoft" modified="false" />
|
|
<para>Logs an error using the specified resource string and other error details.</para>
|
|
</summary>
|
|
<param name="subcategoryResourceName">
|
|
<attribution license="cc4" from="Microsoft" modified="false" />The name of the string resource that describes the error type.</param>
|
|
<param name="errorCode">
|
|
<attribution license="cc4" from="Microsoft" modified="false" />The error code.</param>
|
|
<param name="helpKeyword">
|
|
<attribution license="cc4" from="Microsoft" modified="false" />The Help keyword to associate with the error.</param>
|
|
<param name="file">
|
|
<attribution license="cc4" from="Microsoft" modified="false" />The path to the file containing the error.</param>
|
|
<param name="lineNumber">
|
|
<attribution license="cc4" from="Microsoft" modified="false" />The line in the file where the error occurs.</param>
|
|
<param name="columnNumber">
|
|
<attribution license="cc4" from="Microsoft" modified="false" />The column in the file where the error occurs.</param>
|
|
<param name="endLineNumber">
|
|
<attribution license="cc4" from="Microsoft" modified="false" />The end line in the file where the error occurs.</param>
|
|
<param name="endColumnNumber">
|
|
<attribution license="cc4" from="Microsoft" modified="false" />The end column in the file where the error occurs.</param>
|
|
<param name="messageResourceName">
|
|
<attribution license="cc4" from="Microsoft" modified="false" />The name of the string resource to load.</param>
|
|
<param name="messageArgs">
|
|
<attribution license="cc4" from="Microsoft" modified="false" />The arguments for formatting the loaded string.</param>
|
|
</Docs>
|
|
<AssemblyInfo>
|
|
<AssemblyVersion>2.0.0.0</AssemblyVersion>
|
|
</AssemblyInfo>
|
|
</Member>
|
|
<Member MemberName="LogErrorWithCodeFromResources">
|
|
<MemberSignature Language="C#" Value="public void LogErrorWithCodeFromResources (string messageResourceName, object[] messageArgs);" />
|
|
<MemberType>Method</MemberType>
|
|
<ReturnValue>
|
|
<ReturnType>System.Void</ReturnType>
|
|
</ReturnValue>
|
|
<Parameters>
|
|
<Parameter Name="messageResourceName" Type="System.String" />
|
|
<Parameter Name="messageArgs" Type="System.Object[]">
|
|
<Attributes>
|
|
<Attribute>
|
|
<AttributeName>System.ParamArray</AttributeName>
|
|
</Attribute>
|
|
</Attributes>
|
|
</Parameter>
|
|
</Parameters>
|
|
<Docs>
|
|
<since version="2.0" />
|
|
<remarks>
|
|
<attribution license="cc4" from="Microsoft" modified="false" />
|
|
<para>If the message begins with an error code, the code is extracted and logged with the message.</para>
|
|
<para>If a Help keyword prefix has been provided, it is also logged with the message. The Help keyword is composed by appending the string resource name to the Help keyword prefix. A task can provide a Help keyword prefix with either the <see cref="T:Microsoft.Build.Utilities.Task" /> base class constructor, or the <see cref="P:Microsoft.Build.Utilities.Task.HelpKeywordPrefix" /> property.</para>
|
|
</remarks>
|
|
<summary>
|
|
<attribution license="cc4" from="Microsoft" modified="false" />
|
|
<para>Logs an error with an error code using the specified resource string.</para>
|
|
</summary>
|
|
<param name="messageResourceName">
|
|
<attribution license="cc4" from="Microsoft" modified="false" />The name of the string resource to load.</param>
|
|
<param name="messageArgs">
|
|
<attribution license="cc4" from="Microsoft" modified="false" />The arguments for formatting the loaded string.</param>
|
|
</Docs>
|
|
<AssemblyInfo>
|
|
<AssemblyVersion>2.0.0.0</AssemblyVersion>
|
|
</AssemblyInfo>
|
|
</Member>
|
|
<Member MemberName="LogErrorWithCodeFromResources">
|
|
<MemberSignature Language="C#" Value="public void LogErrorWithCodeFromResources (string subcategoryResourceName, string file, int lineNumber, int columnNumber, int endLineNumber, int endColumnNumber, string messageResourceName, object[] messageArgs);" />
|
|
<MemberType>Method</MemberType>
|
|
<ReturnValue>
|
|
<ReturnType>System.Void</ReturnType>
|
|
</ReturnValue>
|
|
<Parameters>
|
|
<Parameter Name="subcategoryResourceName" Type="System.String" />
|
|
<Parameter Name="file" Type="System.String" />
|
|
<Parameter Name="lineNumber" Type="System.Int32" />
|
|
<Parameter Name="columnNumber" Type="System.Int32" />
|
|
<Parameter Name="endLineNumber" Type="System.Int32" />
|
|
<Parameter Name="endColumnNumber" Type="System.Int32" />
|
|
<Parameter Name="messageResourceName" Type="System.String" />
|
|
<Parameter Name="messageArgs" Type="System.Object[]">
|
|
<Attributes>
|
|
<Attribute>
|
|
<AttributeName>System.ParamArray</AttributeName>
|
|
</Attribute>
|
|
</Attributes>
|
|
</Parameter>
|
|
</Parameters>
|
|
<Docs>
|
|
<since version="2.0" />
|
|
<remarks>
|
|
<attribution license="cc4" from="Microsoft" modified="false" />
|
|
<para>If the message begins with an error code, the code is extracted and logged with the message.</para>
|
|
<para>If a Help keyword prefix has been provided, it is also logged with the message. The Help keyword is composed by appending the string resource name to the Help keyword prefix. A task can provide a Help keyword prefix with either the <see cref="T:Microsoft.Build.Utilities.Task" /> base class constructor, or the <see cref="P:Microsoft.Build.Utilities.Task.HelpKeywordPrefix" /> property.</para>
|
|
<para>The parameters <paramref name="subCategoryResourceName" />, and <paramref name="file" /> can be null.</para>
|
|
<para>The parameters <paramref name="lineNumber" />, <paramref name="columnNumber" />, <paramref name="endLineNumber" />, and <paramref name="endColumnNumber" /> should be set to <math>0</math> if they are not available.</para>
|
|
</remarks>
|
|
<summary>
|
|
<attribution license="cc4" from="Microsoft" modified="false" />
|
|
<para>Logs an error using the specified resource string and other error details.</para>
|
|
</summary>
|
|
<param name="subcategoryResourceName">
|
|
<attribution license="cc4" from="Microsoft" modified="false" />The name of the string resource that describes the error type.</param>
|
|
<param name="file">
|
|
<attribution license="cc4" from="Microsoft" modified="false" />The path to the file containing the error.</param>
|
|
<param name="lineNumber">
|
|
<attribution license="cc4" from="Microsoft" modified="false" />The line in the file where the error occurs.</param>
|
|
<param name="columnNumber">
|
|
<attribution license="cc4" from="Microsoft" modified="false" />The column in the file where the error occurs.</param>
|
|
<param name="endLineNumber">
|
|
<attribution license="cc4" from="Microsoft" modified="false" />The end line in the file where the error occurs.</param>
|
|
<param name="endColumnNumber">
|
|
<attribution license="cc4" from="Microsoft" modified="false" />The end column in the file where the error occurs.</param>
|
|
<param name="messageResourceName">
|
|
<attribution license="cc4" from="Microsoft" modified="false" />The name of the string resource to load.</param>
|
|
<param name="messageArgs">
|
|
<attribution license="cc4" from="Microsoft" modified="false" />The arguments for formatting the loaded string.</param>
|
|
</Docs>
|
|
<AssemblyInfo>
|
|
<AssemblyVersion>2.0.0.0</AssemblyVersion>
|
|
</AssemblyInfo>
|
|
</Member>
|
|
<Member MemberName="LogExternalProjectFinished">
|
|
<MemberSignature Language="C#" Value="public void LogExternalProjectFinished (string message, string helpKeyword, string projectFile, bool succeeded);" />
|
|
<MemberType>Method</MemberType>
|
|
<ReturnValue>
|
|
<ReturnType>System.Void</ReturnType>
|
|
</ReturnValue>
|
|
<Parameters>
|
|
<Parameter Name="message" Type="System.String" />
|
|
<Parameter Name="helpKeyword" Type="System.String" />
|
|
<Parameter Name="projectFile" Type="System.String" />
|
|
<Parameter Name="succeeded" Type="System.Boolean" />
|
|
</Parameters>
|
|
<Docs>
|
|
<remarks>To be added.</remarks>
|
|
<since version="2.0" />
|
|
<summary>
|
|
<attribution license="cc4" from="Microsoft" modified="false" />
|
|
<para>Helps log the custom <see cref="T:Microsoft.Build.Framework.ExternalProjectFinishedEventArgs" /> build event.</para>
|
|
</summary>
|
|
<param name="message">
|
|
<attribution license="cc4" from="Microsoft" modified="false" />The text message.</param>
|
|
<param name="helpKeyword">
|
|
<attribution license="cc4" from="Microsoft" modified="false" />The help keyword.</param>
|
|
<param name="projectFile">
|
|
<attribution license="cc4" from="Microsoft" modified="false" />The name of the project.</param>
|
|
<param name="succeeded">
|
|
<attribution license="cc4" from="Microsoft" modified="false" />true to indicate that project was built successfully; otherwise, false.</param>
|
|
</Docs>
|
|
<AssemblyInfo>
|
|
<AssemblyVersion>2.0.0.0</AssemblyVersion>
|
|
</AssemblyInfo>
|
|
</Member>
|
|
<Member MemberName="LogExternalProjectStarted">
|
|
<MemberSignature Language="C#" Value="public void LogExternalProjectStarted (string message, string helpKeyword, string projectFile, string targetNames);" />
|
|
<MemberType>Method</MemberType>
|
|
<ReturnValue>
|
|
<ReturnType>System.Void</ReturnType>
|
|
</ReturnValue>
|
|
<Parameters>
|
|
<Parameter Name="message" Type="System.String" />
|
|
<Parameter Name="helpKeyword" Type="System.String" />
|
|
<Parameter Name="projectFile" Type="System.String" />
|
|
<Parameter Name="targetNames" Type="System.String" />
|
|
</Parameters>
|
|
<Docs>
|
|
<remarks>To be added.</remarks>
|
|
<since version="2.0" />
|
|
<summary>
|
|
<attribution license="cc4" from="Microsoft" modified="false" />
|
|
<para>Helps log the custom <see cref="T:Microsoft.Build.Framework.ExternalProjectStartedEventArgs" /> build event.</para>
|
|
</summary>
|
|
<param name="message">
|
|
<attribution license="cc4" from="Microsoft" modified="false" />The text message.</param>
|
|
<param name="helpKeyword">
|
|
<attribution license="cc4" from="Microsoft" modified="false" />The help keyword.</param>
|
|
<param name="projectFile">
|
|
<attribution license="cc4" from="Microsoft" modified="false" />The name of the project.</param>
|
|
<param name="targetNames">
|
|
<attribution license="cc4" from="Microsoft" modified="false" />The targets to build. An empty string indicates default targets.</param>
|
|
</Docs>
|
|
<AssemblyInfo>
|
|
<AssemblyVersion>2.0.0.0</AssemblyVersion>
|
|
</AssemblyInfo>
|
|
</Member>
|
|
<Member MemberName="LogMessage">
|
|
<MemberSignature Language="C#" Value="public void LogMessage (string message, object[] messageArgs);" />
|
|
<MemberType>Method</MemberType>
|
|
<ReturnValue>
|
|
<ReturnType>System.Void</ReturnType>
|
|
</ReturnValue>
|
|
<Parameters>
|
|
<Parameter Name="message" Type="System.String" />
|
|
<Parameter Name="messageArgs" Type="System.Object[]">
|
|
<Attributes>
|
|
<Attribute>
|
|
<AttributeName>System.ParamArray</AttributeName>
|
|
</Attribute>
|
|
</Attributes>
|
|
</Parameter>
|
|
</Parameters>
|
|
<Docs>
|
|
<since version="2.0" />
|
|
<remarks>
|
|
<attribution license="cc4" from="Microsoft" modified="false" />
|
|
<para>The <see cref="T:Microsoft.Build.Framework.MessageImportance" /> value of a message is <unmanagedCodeEntityReference>Normal</unmanagedCodeEntityReference> by default.</para>
|
|
</remarks>
|
|
<summary>
|
|
<attribution license="cc4" from="Microsoft" modified="false" />
|
|
<para>Logs a message with the specified string.</para>
|
|
</summary>
|
|
<param name="message">
|
|
<attribution license="cc4" from="Microsoft" modified="false" />The message.</param>
|
|
<param name="messageArgs">
|
|
<attribution license="cc4" from="Microsoft" modified="false" />The arguments for formatting the message.</param>
|
|
</Docs>
|
|
<AssemblyInfo>
|
|
<AssemblyVersion>2.0.0.0</AssemblyVersion>
|
|
</AssemblyInfo>
|
|
</Member>
|
|
<Member MemberName="LogMessage">
|
|
<MemberSignature Language="C#" Value="public void LogMessage (Microsoft.Build.Framework.MessageImportance importance, string message, object[] messageArgs);" />
|
|
<MemberType>Method</MemberType>
|
|
<ReturnValue>
|
|
<ReturnType>System.Void</ReturnType>
|
|
</ReturnValue>
|
|
<Parameters>
|
|
<Parameter Name="importance" Type="Microsoft.Build.Framework.MessageImportance" />
|
|
<Parameter Name="message" Type="System.String" />
|
|
<Parameter Name="messageArgs" Type="System.Object[]">
|
|
<Attributes>
|
|
<Attribute>
|
|
<AttributeName>System.ParamArray</AttributeName>
|
|
</Attribute>
|
|
</Attributes>
|
|
</Parameter>
|
|
</Parameters>
|
|
<Docs>
|
|
<since version="2.0" />
|
|
<remarks>
|
|
<attribution license="cc4" from="Microsoft" modified="false" />
|
|
<para>Take care to order the parameters correctly or the other overload will be called inadvertently.</para>
|
|
</remarks>
|
|
<summary>
|
|
<attribution license="cc4" from="Microsoft" modified="false" />
|
|
<para>Logs a message with the specified string and importance.</para>
|
|
</summary>
|
|
<param name="importance">
|
|
<attribution license="cc4" from="Microsoft" modified="false" />One of the enumeration values that specifies the importance of the message.</param>
|
|
<param name="message">
|
|
<attribution license="cc4" from="Microsoft" modified="false" />The message.</param>
|
|
<param name="messageArgs">
|
|
<attribution license="cc4" from="Microsoft" modified="false" />The arguments for formatting the message.</param>
|
|
</Docs>
|
|
<AssemblyInfo>
|
|
<AssemblyVersion>2.0.0.0</AssemblyVersion>
|
|
</AssemblyInfo>
|
|
</Member>
|
|
<Member MemberName="LogMessageFromResources">
|
|
<MemberSignature Language="C#" Value="public void LogMessageFromResources (string messageResourceName, object[] messageArgs);" />
|
|
<MemberType>Method</MemberType>
|
|
<ReturnValue>
|
|
<ReturnType>System.Void</ReturnType>
|
|
</ReturnValue>
|
|
<Parameters>
|
|
<Parameter Name="messageResourceName" Type="System.String" />
|
|
<Parameter Name="messageArgs" Type="System.Object[]">
|
|
<Attributes>
|
|
<Attribute>
|
|
<AttributeName>System.ParamArray</AttributeName>
|
|
</Attribute>
|
|
</Attributes>
|
|
</Parameter>
|
|
</Parameters>
|
|
<Docs>
|
|
<since version="2.0" />
|
|
<remarks>
|
|
<attribution license="cc4" from="Microsoft" modified="false" />
|
|
<para>The <see cref="T:Microsoft.Build.Framework.MessageImportance" /> value of a message is <unmanagedCodeEntityReference>Normal</unmanagedCodeEntityReference> by default.</para>
|
|
</remarks>
|
|
<summary>
|
|
<attribution license="cc4" from="Microsoft" modified="false" />
|
|
<para>Logs a message with the specified resource string.</para>
|
|
</summary>
|
|
<param name="messageResourceName">
|
|
<attribution license="cc4" from="Microsoft" modified="false" />The name of the string resource to load.</param>
|
|
<param name="messageArgs">
|
|
<attribution license="cc4" from="Microsoft" modified="false" />The arguments for formatting the loaded string.</param>
|
|
</Docs>
|
|
<AssemblyInfo>
|
|
<AssemblyVersion>2.0.0.0</AssemblyVersion>
|
|
</AssemblyInfo>
|
|
</Member>
|
|
<Member MemberName="LogMessageFromResources">
|
|
<MemberSignature Language="C#" Value="public void LogMessageFromResources (Microsoft.Build.Framework.MessageImportance importance, string messageResourceName, object[] messageArgs);" />
|
|
<MemberType>Method</MemberType>
|
|
<ReturnValue>
|
|
<ReturnType>System.Void</ReturnType>
|
|
</ReturnValue>
|
|
<Parameters>
|
|
<Parameter Name="importance" Type="Microsoft.Build.Framework.MessageImportance" />
|
|
<Parameter Name="messageResourceName" Type="System.String" />
|
|
<Parameter Name="messageArgs" Type="System.Object[]">
|
|
<Attributes>
|
|
<Attribute>
|
|
<AttributeName>System.ParamArray</AttributeName>
|
|
</Attribute>
|
|
</Attributes>
|
|
</Parameter>
|
|
</Parameters>
|
|
<Docs>
|
|
<since version="2.0" />
|
|
<remarks>
|
|
<attribution license="cc4" from="Microsoft" modified="false" />
|
|
<para>Take care to order the parameters correctly or the other overload will be called inadvertently.</para>
|
|
</remarks>
|
|
<summary>
|
|
<attribution license="cc4" from="Microsoft" modified="false" />
|
|
<para>Logs a message with the specified resource string and importance.</para>
|
|
</summary>
|
|
<param name="importance">
|
|
<attribution license="cc4" from="Microsoft" modified="false" />One of the enumeration values that specifies the importance of the message.</param>
|
|
<param name="messageResourceName">
|
|
<attribution license="cc4" from="Microsoft" modified="false" />The name of the string resource to load.</param>
|
|
<param name="messageArgs">
|
|
<attribution license="cc4" from="Microsoft" modified="false" />The arguments for formatting the loaded string.</param>
|
|
</Docs>
|
|
<AssemblyInfo>
|
|
<AssemblyVersion>2.0.0.0</AssemblyVersion>
|
|
</AssemblyInfo>
|
|
</Member>
|
|
<Member MemberName="LogMessageFromText">
|
|
<MemberSignature Language="C#" Value="public bool LogMessageFromText (string lineOfText, Microsoft.Build.Framework.MessageImportance importance);" />
|
|
<MemberType>Method</MemberType>
|
|
<ReturnValue>
|
|
<ReturnType>System.Boolean</ReturnType>
|
|
</ReturnValue>
|
|
<Parameters>
|
|
<Parameter Name="lineOfText" Type="System.String" />
|
|
<Parameter Name="importance" Type="Microsoft.Build.Framework.MessageImportance" />
|
|
</Parameters>
|
|
<Docs>
|
|
<param name="importance">To be added.</param>
|
|
<since version="2.0" />
|
|
<remarks>
|
|
<attribution license="cc4" from="Microsoft" modified="false" />
|
|
<para>Errors messages and warnings are only logged for lines that fit the canonical format. All other lines are treated as messages.</para>
|
|
</remarks>
|
|
<summary>
|
|
<attribution license="cc4" from="Microsoft" modified="false" />
|
|
<para>Logs an error message or warning from the given line of text.</para>
|
|
</summary>
|
|
<returns>
|
|
<attribution license="cc4" from="Microsoft" modified="false" />
|
|
<para>true if an error was logged; otherwise, false.</para>
|
|
</returns>
|
|
<param name="lineOfText">
|
|
<attribution license="cc4" from="Microsoft" modified="false" />The line of text to log from.</param>
|
|
</Docs>
|
|
<AssemblyInfo>
|
|
<AssemblyVersion>2.0.0.0</AssemblyVersion>
|
|
</AssemblyInfo>
|
|
</Member>
|
|
<Member MemberName="LogMessagesFromFile">
|
|
<MemberSignature Language="C#" Value="public bool LogMessagesFromFile (string filename);" />
|
|
<MemberType>Method</MemberType>
|
|
<ReturnValue>
|
|
<ReturnType>System.Boolean</ReturnType>
|
|
</ReturnValue>
|
|
<Parameters>
|
|
<Parameter Name="filename" Type="System.String" />
|
|
</Parameters>
|
|
<Docs>
|
|
<param name="filename">To be added.</param>
|
|
<since version="2.0" />
|
|
<remarks>
|
|
<attribution license="cc4" from="Microsoft" modified="false" />
|
|
<para>Errors and warnings are logged for lines that fit a particular canonical format. All other lines are logged as messages.</para>
|
|
</remarks>
|
|
<summary>
|
|
<attribution license="cc4" from="Microsoft" modified="false" />
|
|
<para>Logs errors, warnings, and messages for each line of text in the given file.</para>
|
|
</summary>
|
|
<returns>
|
|
<attribution license="cc4" from="Microsoft" modified="false" />
|
|
<para>true to indicate at least one error was logged; otherwise, false.</para>
|
|
</returns>
|
|
</Docs>
|
|
<AssemblyInfo>
|
|
<AssemblyVersion>2.0.0.0</AssemblyVersion>
|
|
</AssemblyInfo>
|
|
</Member>
|
|
<Member MemberName="LogMessagesFromFile">
|
|
<MemberSignature Language="C#" Value="public bool LogMessagesFromFile (string filename, Microsoft.Build.Framework.MessageImportance messageImportance);" />
|
|
<MemberType>Method</MemberType>
|
|
<ReturnValue>
|
|
<ReturnType>System.Boolean</ReturnType>
|
|
</ReturnValue>
|
|
<Parameters>
|
|
<Parameter Name="filename" Type="System.String" />
|
|
<Parameter Name="messageImportance" Type="Microsoft.Build.Framework.MessageImportance" />
|
|
</Parameters>
|
|
<Docs>
|
|
<param name="filename">To be added.</param>
|
|
<since version="2.0" />
|
|
<remarks>
|
|
<attribution license="cc4" from="Microsoft" modified="false" />
|
|
<para>Errors and warnings are logged for lines that fit a particular canonical format. All other lines are logged as messages.</para>
|
|
</remarks>
|
|
<summary>
|
|
<attribution license="cc4" from="Microsoft" modified="false" />
|
|
<para>Logs errors, warnings, and messages for each line of text in the given file. Also logs the importance of messages.</para>
|
|
</summary>
|
|
<returns>
|
|
<attribution license="cc4" from="Microsoft" modified="false" />
|
|
<para>true to indicate at least one error was logged; otherwise, false.</para>
|
|
</returns>
|
|
<param name="messageImportance">
|
|
<attribution license="cc4" from="Microsoft" modified="false" />One of the enumeration values that specifies the importance of logged messages.</param>
|
|
</Docs>
|
|
<AssemblyInfo>
|
|
<AssemblyVersion>2.0.0.0</AssemblyVersion>
|
|
</AssemblyInfo>
|
|
</Member>
|
|
<Member MemberName="LogMessagesFromStream">
|
|
<MemberSignature Language="C#" Value="public bool LogMessagesFromStream (System.IO.TextReader stream, Microsoft.Build.Framework.MessageImportance messageImportance);" />
|
|
<MemberType>Method</MemberType>
|
|
<ReturnValue>
|
|
<ReturnType>System.Boolean</ReturnType>
|
|
</ReturnValue>
|
|
<Parameters>
|
|
<Parameter Name="stream" Type="System.IO.TextReader" />
|
|
<Parameter Name="messageImportance" Type="Microsoft.Build.Framework.MessageImportance" />
|
|
</Parameters>
|
|
<Docs>
|
|
<since version="2.0" />
|
|
<remarks>
|
|
<attribution license="cc4" from="Microsoft" modified="false" />
|
|
<para>This method is not thread-safe.</para>
|
|
</remarks>
|
|
<summary>
|
|
<attribution license="cc4" from="Microsoft" modified="false" />
|
|
<para>Logs an error message or warning from the given stream.</para>
|
|
</summary>
|
|
<returns>
|
|
<attribution license="cc4" from="Microsoft" modified="false" />
|
|
<para>true if an error was logged; otherwise, false.</para>
|
|
</returns>
|
|
<param name="stream">
|
|
<attribution license="cc4" from="Microsoft" modified="false" />A <see cref="T:System.IO.TextReader" /> that reads the stream to log from.</param>
|
|
<param name="messageImportance">
|
|
<attribution license="cc4" from="Microsoft" modified="false" />One of the values of <see cref="T:Microsoft.Build.Framework.MessageImportance" /> that indicates the importance level of the command line.</param>
|
|
</Docs>
|
|
<AssemblyInfo>
|
|
<AssemblyVersion>2.0.0.0</AssemblyVersion>
|
|
</AssemblyInfo>
|
|
</Member>
|
|
<Member MemberName="LogWarning">
|
|
<MemberSignature Language="C#" Value="public void LogWarning (string message, object[] messageArgs);" />
|
|
<MemberType>Method</MemberType>
|
|
<ReturnValue>
|
|
<ReturnType>System.Void</ReturnType>
|
|
</ReturnValue>
|
|
<Parameters>
|
|
<Parameter Name="message" Type="System.String" />
|
|
<Parameter Name="messageArgs" Type="System.Object[]">
|
|
<Attributes>
|
|
<Attribute>
|
|
<AttributeName>System.ParamArray</AttributeName>
|
|
</Attribute>
|
|
</Attributes>
|
|
</Parameter>
|
|
</Parameters>
|
|
<Docs>
|
|
<since version="2.0" />
|
|
<remarks>
|
|
<attribution license="cc4" from="Microsoft" modified="false" />
|
|
<para>This method is not thread-safe.</para>
|
|
</remarks>
|
|
<summary>
|
|
<attribution license="cc4" from="Microsoft" modified="false" />
|
|
<para>Logs a warning with the specified message.</para>
|
|
</summary>
|
|
<param name="message">
|
|
<attribution license="cc4" from="Microsoft" modified="false" />The message.</param>
|
|
<param name="messageArgs">
|
|
<attribution license="cc4" from="Microsoft" modified="false" />Optional arguments for formatting the message string.</param>
|
|
</Docs>
|
|
<AssemblyInfo>
|
|
<AssemblyVersion>2.0.0.0</AssemblyVersion>
|
|
</AssemblyInfo>
|
|
</Member>
|
|
<Member MemberName="LogWarning">
|
|
<MemberSignature Language="C#" Value="public void LogWarning (string subcategory, string warningCode, string helpKeyword, string file, int lineNumber, int columnNumber, int endLineNumber, int endColumnNumber, string message, object[] messageArgs);" />
|
|
<MemberType>Method</MemberType>
|
|
<ReturnValue>
|
|
<ReturnType>System.Void</ReturnType>
|
|
</ReturnValue>
|
|
<Parameters>
|
|
<Parameter Name="subcategory" Type="System.String" />
|
|
<Parameter Name="warningCode" Type="System.String" />
|
|
<Parameter Name="helpKeyword" Type="System.String" />
|
|
<Parameter Name="file" Type="System.String" />
|
|
<Parameter Name="lineNumber" Type="System.Int32" />
|
|
<Parameter Name="columnNumber" Type="System.Int32" />
|
|
<Parameter Name="endLineNumber" Type="System.Int32" />
|
|
<Parameter Name="endColumnNumber" Type="System.Int32" />
|
|
<Parameter Name="message" Type="System.String" />
|
|
<Parameter Name="messageArgs" Type="System.Object[]">
|
|
<Attributes>
|
|
<Attribute>
|
|
<AttributeName>System.ParamArray</AttributeName>
|
|
</Attribute>
|
|
</Attributes>
|
|
</Parameter>
|
|
</Parameters>
|
|
<Docs>
|
|
<since version="2.0" />
|
|
<remarks>
|
|
<attribution license="cc4" from="Microsoft" modified="false" />
|
|
<para>The parameters <paramref name="subCategory" />, <paramref name="warningCode" />, <paramref name="helpKeyword" />, and <paramref name="file" /> can be null.</para>
|
|
<para>The parameters <paramref name="lineNumber" />, <paramref name="columnNumber" />, <paramref name="endLineNumber" />, and <paramref name="endColumnNumber" /> should be set to <math>0</math> if they are not available.</para>
|
|
</remarks>
|
|
<summary>
|
|
<attribution license="cc4" from="Microsoft" modified="false" />
|
|
<para>Logs a warning using the specified message and other warning details.</para>
|
|
</summary>
|
|
<param name="subcategory">
|
|
<attribution license="cc4" from="Microsoft" modified="false" />The description of the warning type.</param>
|
|
<param name="warningCode">
|
|
<attribution license="cc4" from="Microsoft" modified="false" />The warning code.</param>
|
|
<param name="helpKeyword">
|
|
<attribution license="cc4" from="Microsoft" modified="false" />The Help keyword to associate with the warning.</param>
|
|
<param name="file">
|
|
<attribution license="cc4" from="Microsoft" modified="false" />The path to the file containing the warning.</param>
|
|
<param name="lineNumber">
|
|
<attribution license="cc4" from="Microsoft" modified="false" />The line in the file where the warning occurs.</param>
|
|
<param name="columnNumber">
|
|
<attribution license="cc4" from="Microsoft" modified="false" />The column in the file where the warning occurs.</param>
|
|
<param name="endLineNumber">
|
|
<attribution license="cc4" from="Microsoft" modified="false" />The end line in the file where the warning occurs.</param>
|
|
<param name="endColumnNumber">
|
|
<attribution license="cc4" from="Microsoft" modified="false" />The end column in the file where the warning occurs.</param>
|
|
<param name="message">
|
|
<attribution license="cc4" from="Microsoft" modified="false" />The message.</param>
|
|
<param name="messageArgs">
|
|
<attribution license="cc4" from="Microsoft" modified="false" />Optional arguments for formatting the message string.</param>
|
|
</Docs>
|
|
<AssemblyInfo>
|
|
<AssemblyVersion>2.0.0.0</AssemblyVersion>
|
|
</AssemblyInfo>
|
|
</Member>
|
|
<Member MemberName="LogWarningFromException">
|
|
<MemberSignature Language="C#" Value="public void LogWarningFromException (Exception e);" />
|
|
<MemberType>Method</MemberType>
|
|
<ReturnValue>
|
|
<ReturnType>System.Void</ReturnType>
|
|
</ReturnValue>
|
|
<Parameters>
|
|
<Parameter Name="e" Type="System.Exception" />
|
|
</Parameters>
|
|
<Docs>
|
|
<param name="e">To be added.</param>
|
|
<since version="2.0" />
|
|
<remarks>
|
|
<attribution license="cc4" from="Microsoft" modified="false" />
|
|
<para>This method is not thread-safe.</para>
|
|
</remarks>
|
|
<summary>
|
|
<attribution license="cc4" from="Microsoft" modified="false" />
|
|
<para>Logs a warning using the message from the specified exception.</para>
|
|
</summary>
|
|
</Docs>
|
|
<AssemblyInfo>
|
|
<AssemblyVersion>2.0.0.0</AssemblyVersion>
|
|
</AssemblyInfo>
|
|
</Member>
|
|
<Member MemberName="LogWarningFromException">
|
|
<MemberSignature Language="C#" Value="public void LogWarningFromException (Exception e, bool showStackTrace);" />
|
|
<MemberType>Method</MemberType>
|
|
<ReturnValue>
|
|
<ReturnType>System.Void</ReturnType>
|
|
</ReturnValue>
|
|
<Parameters>
|
|
<Parameter Name="e" Type="System.Exception" />
|
|
<Parameter Name="showStackTrace" Type="System.Boolean" />
|
|
</Parameters>
|
|
<Docs>
|
|
<param name="e">To be added.</param>
|
|
<since version="2.0" />
|
|
<remarks>
|
|
<attribution license="cc4" from="Microsoft" modified="false" />
|
|
<para>This method is not thread-safe.</para>
|
|
</remarks>
|
|
<summary>
|
|
<attribution license="cc4" from="Microsoft" modified="false" />
|
|
<para>Logs a warning using the message, and optionally the stack trace, from the given exception.</para>
|
|
</summary>
|
|
<param name="showStackTrace">
|
|
<attribution license="cc4" from="Microsoft" modified="false" />true to include the stack trace in the log; otherwise, false.</param>
|
|
</Docs>
|
|
<AssemblyInfo>
|
|
<AssemblyVersion>2.0.0.0</AssemblyVersion>
|
|
</AssemblyInfo>
|
|
</Member>
|
|
<Member MemberName="LogWarningFromResources">
|
|
<MemberSignature Language="C#" Value="public void LogWarningFromResources (string messageResourceName, object[] messageArgs);" />
|
|
<MemberType>Method</MemberType>
|
|
<ReturnValue>
|
|
<ReturnType>System.Void</ReturnType>
|
|
</ReturnValue>
|
|
<Parameters>
|
|
<Parameter Name="messageResourceName" Type="System.String" />
|
|
<Parameter Name="messageArgs" Type="System.Object[]">
|
|
<Attributes>
|
|
<Attribute>
|
|
<AttributeName>System.ParamArray</AttributeName>
|
|
</Attribute>
|
|
</Attributes>
|
|
</Parameter>
|
|
</Parameters>
|
|
<Docs>
|
|
<since version="2.0" />
|
|
<remarks>
|
|
<attribution license="cc4" from="Microsoft" modified="false" />
|
|
<para>This method is not thread-safe.</para>
|
|
</remarks>
|
|
<summary>
|
|
<attribution license="cc4" from="Microsoft" modified="false" />
|
|
<para>Logs a warning using the specified resource string.</para>
|
|
</summary>
|
|
<param name="messageResourceName">
|
|
<attribution license="cc4" from="Microsoft" modified="false" />The name of the string resource to load.</param>
|
|
<param name="messageArgs">
|
|
<attribution license="cc4" from="Microsoft" modified="false" />The arguments for formatting the loaded string.</param>
|
|
</Docs>
|
|
<AssemblyInfo>
|
|
<AssemblyVersion>2.0.0.0</AssemblyVersion>
|
|
</AssemblyInfo>
|
|
</Member>
|
|
<Member MemberName="LogWarningFromResources">
|
|
<MemberSignature Language="C#" Value="public void LogWarningFromResources (string subcategoryResourceName, string warningCode, string helpKeyword, string file, int lineNumber, int columnNumber, int endLineNumber, int endColumnNumber, string messageResourceName, object[] messageArgs);" />
|
|
<MemberType>Method</MemberType>
|
|
<ReturnValue>
|
|
<ReturnType>System.Void</ReturnType>
|
|
</ReturnValue>
|
|
<Parameters>
|
|
<Parameter Name="subcategoryResourceName" Type="System.String" />
|
|
<Parameter Name="warningCode" Type="System.String" />
|
|
<Parameter Name="helpKeyword" Type="System.String" />
|
|
<Parameter Name="file" Type="System.String" />
|
|
<Parameter Name="lineNumber" Type="System.Int32" />
|
|
<Parameter Name="columnNumber" Type="System.Int32" />
|
|
<Parameter Name="endLineNumber" Type="System.Int32" />
|
|
<Parameter Name="endColumnNumber" Type="System.Int32" />
|
|
<Parameter Name="messageResourceName" Type="System.String" />
|
|
<Parameter Name="messageArgs" Type="System.Object[]">
|
|
<Attributes>
|
|
<Attribute>
|
|
<AttributeName>System.ParamArray</AttributeName>
|
|
</Attribute>
|
|
</Attributes>
|
|
</Parameter>
|
|
</Parameters>
|
|
<Docs>
|
|
<since version="2.0" />
|
|
<remarks>
|
|
<attribution license="cc4" from="Microsoft" modified="false" />
|
|
<para>The parameters <paramref name="subCategoryResourceName" />, <paramref name="warningCode" />, <paramref name="helpKeyword" />, and <paramref name="file" /> can be null.</para>
|
|
<para>The parameters <paramref name="lineNumber" />, <paramref name="columnNumber" />, <paramref name="endLineNumber" />, and <paramref name="endColumnNumber" /> should be set to <math>0</math> if they are not available.</para>
|
|
</remarks>
|
|
<summary>
|
|
<attribution license="cc4" from="Microsoft" modified="false" />
|
|
<para>Logs a warning using the specified resource string and other warning details.</para>
|
|
</summary>
|
|
<param name="subcategoryResourceName">
|
|
<attribution license="cc4" from="Microsoft" modified="false" />The name of the string resource that describes the warning type.</param>
|
|
<param name="warningCode">
|
|
<attribution license="cc4" from="Microsoft" modified="false" />The warning code.</param>
|
|
<param name="helpKeyword">
|
|
<attribution license="cc4" from="Microsoft" modified="false" />The Help keyword to associate with the warning.</param>
|
|
<param name="file">
|
|
<attribution license="cc4" from="Microsoft" modified="false" />The path to the file containing the warning.</param>
|
|
<param name="lineNumber">
|
|
<attribution license="cc4" from="Microsoft" modified="false" />The line in the file where the warning occurs.</param>
|
|
<param name="columnNumber">
|
|
<attribution license="cc4" from="Microsoft" modified="false" />The column in the file where the warning occurs.</param>
|
|
<param name="endLineNumber">
|
|
<attribution license="cc4" from="Microsoft" modified="false" />The end line in the file where the warning occurs.</param>
|
|
<param name="endColumnNumber">
|
|
<attribution license="cc4" from="Microsoft" modified="false" />The end column in the file where the warning occurs.</param>
|
|
<param name="messageResourceName">
|
|
<attribution license="cc4" from="Microsoft" modified="false" />The name of the string resource to load.</param>
|
|
<param name="messageArgs">
|
|
<attribution license="cc4" from="Microsoft" modified="false" />The arguments for formatting the loaded string.</param>
|
|
</Docs>
|
|
<AssemblyInfo>
|
|
<AssemblyVersion>2.0.0.0</AssemblyVersion>
|
|
</AssemblyInfo>
|
|
</Member>
|
|
<Member MemberName="LogWarningWithCodeFromResources">
|
|
<MemberSignature Language="C#" Value="public void LogWarningWithCodeFromResources (string messageResourceName, object[] messageArgs);" />
|
|
<MemberType>Method</MemberType>
|
|
<ReturnValue>
|
|
<ReturnType>System.Void</ReturnType>
|
|
</ReturnValue>
|
|
<Parameters>
|
|
<Parameter Name="messageResourceName" Type="System.String" />
|
|
<Parameter Name="messageArgs" Type="System.Object[]">
|
|
<Attributes>
|
|
<Attribute>
|
|
<AttributeName>System.ParamArray</AttributeName>
|
|
</Attribute>
|
|
</Attributes>
|
|
</Parameter>
|
|
</Parameters>
|
|
<Docs>
|
|
<since version="2.0" />
|
|
<remarks>
|
|
<attribution license="cc4" from="Microsoft" modified="false" />
|
|
<para>If the message begins with a warning code, the code is extracted and logged with the message.</para>
|
|
<para>If a Help keyword prefix has been provided, it is also logged with the message. The Help keyword is composed by appending the string resource name to the Help keyword prefix. A task can provide a Help keyword prefix with either the <see cref="T:Microsoft.Build.Utilities.Task" /> base class constructor, or the <see cref="P:Microsoft.Build.Utilities.Task.HelpKeywordPrefix" /> property.</para>
|
|
</remarks>
|
|
<summary>
|
|
<attribution license="cc4" from="Microsoft" modified="false" />
|
|
<para>Logs a warning with a warning code using the specified resource string.</para>
|
|
</summary>
|
|
<param name="messageResourceName">
|
|
<attribution license="cc4" from="Microsoft" modified="false" />The name of the string resource to load.</param>
|
|
<param name="messageArgs">
|
|
<attribution license="cc4" from="Microsoft" modified="false" />The arguments for formatting the loaded string.</param>
|
|
</Docs>
|
|
<AssemblyInfo>
|
|
<AssemblyVersion>2.0.0.0</AssemblyVersion>
|
|
</AssemblyInfo>
|
|
</Member>
|
|
<Member MemberName="LogWarningWithCodeFromResources">
|
|
<MemberSignature Language="C#" Value="public void LogWarningWithCodeFromResources (string subcategoryResourceName, string file, int lineNumber, int columnNumber, int endLineNumber, int endColumnNumber, string messageResourceName, object[] messageArgs);" />
|
|
<MemberType>Method</MemberType>
|
|
<ReturnValue>
|
|
<ReturnType>System.Void</ReturnType>
|
|
</ReturnValue>
|
|
<Parameters>
|
|
<Parameter Name="subcategoryResourceName" Type="System.String" />
|
|
<Parameter Name="file" Type="System.String" />
|
|
<Parameter Name="lineNumber" Type="System.Int32" />
|
|
<Parameter Name="columnNumber" Type="System.Int32" />
|
|
<Parameter Name="endLineNumber" Type="System.Int32" />
|
|
<Parameter Name="endColumnNumber" Type="System.Int32" />
|
|
<Parameter Name="messageResourceName" Type="System.String" />
|
|
<Parameter Name="messageArgs" Type="System.Object[]">
|
|
<Attributes>
|
|
<Attribute>
|
|
<AttributeName>System.ParamArray</AttributeName>
|
|
</Attribute>
|
|
</Attributes>
|
|
</Parameter>
|
|
</Parameters>
|
|
<Docs>
|
|
<since version="2.0" />
|
|
<remarks>
|
|
<attribution license="cc4" from="Microsoft" modified="false" />
|
|
<para>If the message begins with a warning code, the code is extracted and logged with the message.</para>
|
|
<para>If a Help keyword prefix has been provided, it is also logged with the message. The Help keyword is composed by appending the string resource name to the Help keyword prefix. A task can provide a Help keyword prefix with either the <see cref="T:Microsoft.Build.Utilities.Task" /> base class constructor, or the <see cref="P:Microsoft.Build.Utilities.Task.HelpKeywordPrefix" /> property.</para>
|
|
<para>The parameters <paramref name="subCategoryResourceName" />, and <paramref name="file" /> can be null.</para>
|
|
<para>The parameters <paramref name="lineNumber" />, <paramref name="columnNumber" />, <paramref name="endLineNumber" />, and <paramref name="endColumnNumber" /> should be set to <math>0</math> if they are not available.</para>
|
|
</remarks>
|
|
<summary>
|
|
<attribution license="cc4" from="Microsoft" modified="false" />
|
|
<para>Logs a warning with a warning code using the specified resource string and other warning details.</para>
|
|
</summary>
|
|
<param name="subcategoryResourceName">
|
|
<attribution license="cc4" from="Microsoft" modified="false" />The name of the string resource that describes the warning type.</param>
|
|
<param name="file">
|
|
<attribution license="cc4" from="Microsoft" modified="false" />The path to the file containing the warning.</param>
|
|
<param name="lineNumber">
|
|
<attribution license="cc4" from="Microsoft" modified="false" />The line in the file where the warning occurs.</param>
|
|
<param name="columnNumber">
|
|
<attribution license="cc4" from="Microsoft" modified="false" />The column in the file where the warning occurs.</param>
|
|
<param name="endLineNumber">
|
|
<attribution license="cc4" from="Microsoft" modified="false" />The end line in the file where the warning occurs.</param>
|
|
<param name="endColumnNumber">
|
|
<attribution license="cc4" from="Microsoft" modified="false" />The end column in the file where the warning occurs.</param>
|
|
<param name="messageResourceName">
|
|
<attribution license="cc4" from="Microsoft" modified="false" />The name of the string resource to load.</param>
|
|
<param name="messageArgs">
|
|
<attribution license="cc4" from="Microsoft" modified="false" />The arguments for formatting the loaded string.</param>
|
|
</Docs>
|
|
<AssemblyInfo>
|
|
<AssemblyVersion>2.0.0.0</AssemblyVersion>
|
|
</AssemblyInfo>
|
|
</Member>
|
|
<Member MemberName="TaskName">
|
|
<MemberSignature Language="C#" Value="protected string TaskName { 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 name of the parent task.</para>
|
|
</summary>
|
|
</Docs>
|
|
<AssemblyInfo>
|
|
<AssemblyVersion>2.0.0.0</AssemblyVersion>
|
|
</AssemblyInfo>
|
|
</Member>
|
|
<Member MemberName="TaskResources">
|
|
<MemberSignature Language="C#" Value="public System.Resources.ResourceManager TaskResources { set; get; }" />
|
|
<MemberType>Property</MemberType>
|
|
<ReturnValue>
|
|
<ReturnType>System.Resources.ResourceManager</ReturnType>
|
|
</ReturnValue>
|
|
<Docs>
|
|
<value>To be added.</value>
|
|
<since version="2.0" />
|
|
<remarks>
|
|
<attribution license="cc4" from="Microsoft" modified="false" />
|
|
<para>If derived classes have localized strings, then they should register their resources with this property.</para>
|
|
</remarks>
|
|
<summary>
|
|
<attribution license="cc4" from="Microsoft" modified="false" />
|
|
<para>Gets or sets the culture-specific resources used by the logging methods.</para>
|
|
</summary>
|
|
</Docs>
|
|
<AssemblyInfo>
|
|
<AssemblyVersion>2.0.0.0</AssemblyVersion>
|
|
</AssemblyInfo>
|
|
</Member>
|
|
</Members>
|
|
</Type> |