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

Logs an error using the specified resource string 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 LogErrorWithCodeFromResources ( _
    subcategoryResourceName As String, _
    file As String, _
    lineNumber As Integer, _
    columnNumber As Integer, _
    endLineNumber As Integer, _
    endColumnNumber As Integer, _
    messageResourceName As String, _
    ParamArray messageArgs As Object() _
)
public void LogErrorWithCodeFromResources(
    string subcategoryResourceName,
    string file,
    int lineNumber,
    int columnNumber,
    int endLineNumber,
    int endColumnNumber,
    string messageResourceName,
    params Object[] messageArgs
)
public:
void LogErrorWithCodeFromResources(
    String^ subcategoryResourceName, 
    String^ file, 
    int lineNumber, 
    int columnNumber, 
    int endLineNumber, 
    int endColumnNumber, 
    String^ messageResourceName, 
    ... array<Object^>^ messageArgs
)
member LogErrorWithCodeFromResources : 
        subcategoryResourceName:string * 
        file:string * 
        lineNumber:int * 
        columnNumber:int * 
        endLineNumber:int * 
        endColumnNumber:int * 
        messageResourceName:string * 
        messageArgs:Object[] -> unit
public function LogErrorWithCodeFromResources(
    subcategoryResourceName : String, 
    file : String, 
    lineNumber : int, 
    columnNumber : int, 
    endLineNumber : int, 
    endColumnNumber : int, 
    messageResourceName : String, 
    ... messageArgs : Object[]
)

Parameters

  • subcategoryResourceName
    Type: System.String

    The name of the string resource that describes the error type.

  • 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.

  • messageResourceName
    Type: System.String

    The name of the string resource to load.

  • messageArgs
    Type: array<System.Object[]

    The arguments for formatting the loaded string.

Exceptions

Exception Condition
ArgumentNullException

messageResourceName is nulla null reference (Nothing in Visual Basic).

Remarks

If the message begins with an error code, the code is extracted and logged with the message.

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 Task base class constructor, or the HelpKeywordPrefix property.

The parameters subCategoryResourceName, 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

See Also

Reference

TaskLoggingHelper Class

LogErrorWithCodeFromResources Overload

Microsoft.Build.Utilities Namespace