TaskLoggingHelper.LogError Method (String, String, String, String, Int32, Int32, Int32, Int32, String, array<Object )

Logs an error using the specified message and other error details.

MSBuild is now included in Visual Studio instead of the .NET Framework. You can use MSBuild 12.0 side-by-side with versions previously deployed with the .NET Framework.For more information, see What's New in MSBuild 12.0.

Namespace:  Microsoft.Build.Utilities
Assembly:  Microsoft.Build.Utilities.Core (in Microsoft.Build.Utilities.Core.dll)

Syntax

'Declaration
Public Sub LogError ( _
    subcategory As String, _
    errorCode As String, _
    helpKeyword As String, _
    file As String, _
    lineNumber As Integer, _
    columnNumber As Integer, _
    endLineNumber As Integer, _
    endColumnNumber As Integer, _
    message As String, _
    ParamArray messageArgs As Object() _
)

public void LogError(
    string subcategory,
    string errorCode,
    string helpKeyword,
    string file,
    int lineNumber,
    int columnNumber,
    int endLineNumber,
    int endColumnNumber,
    string message,
    params Object[] messageArgs
)

public:
void LogError(
    String^ subcategory, 
    String^ errorCode, 
    String^ helpKeyword, 
    String^ file, 
    int lineNumber, 
    int columnNumber, 
    int endLineNumber, 
    int endColumnNumber, 
    String^ message, 
    ... array<Object^>^ messageArgs
)

member LogError : 
        subcategory:string * 
        errorCode:string * 
        helpKeyword:string * 
        file:string * 
        lineNumber:int * 
        columnNumber:int * 
        endLineNumber:int * 
        endColumnNumber:int * 
        message:string * 
        messageArgs:Object[] -> unit

public function LogError(
    subcategory : String, 
    errorCode : String, 
    helpKeyword : String, 
    file : String, 
    lineNumber : int, 
    columnNumber : int, 
    endLineNumber : int, 
    endColumnNumber : int, 
    message : String, 
    ... messageArgs : Object[]
)

Parameters

• subcategory
  Type: System.String

  The description of the error type.

• errorCode
  Type: System.String

  The error code.

• helpKeyword
  Type: System.String

  The Help keyword to associate with the error.

• file
  Type: System.String

  The path to the file containing the error.

• lineNumber
  Type: System.Int32

  The line in the file where the error occurs.

• columnNumber
  Type: System.Int32

  The column in the file where the error occurs.

• endLineNumber
  Type: System.Int32

  The end line in the file where the error occurs.

• endColumnNumber
  Type: System.Int32

  The end column in the file where the error occurs.

• message
  Type: System.String

  The message.

• messageArgs
  Type: array<System.Object[]

  Optional arguments for formatting the message string.

Exceptions

Exception	Condition
ArgumentNullException	message is nulla null reference (Nothing in Visual Basic).

Remarks

The parameters subCategory, errorCode, helpKeyword, and file can be nulla null reference (Nothing in Visual Basic).

The parameters lineNumber, columnNumber, endLineNumber, and endColumnNumber should be set to 0 if they are not available.

.NET Framework Security

• Full trust for the immediate caller. This member cannot be used by partially trusted code. For more information, see dd66cd4c-b087-415f-9c3e-94e3a1835f74.

See Also

Reference

TaskLoggingHelper Class

LogError Overload

Microsoft.Build.Utilities Namespace