TaskLoggingHelper.LogErrorWithCodeFromResources Method (String, String, Int32, Int32, Int32, Int32, String, Object[])

 

Logs an error using the specified resource string and other error details.

Namespace:   Microsoft.Build.Utilities
Assembly:  Microsoft.Build.Utilities.v4.0 (in Microsoft.Build.Utilities.v4.0.dll)

public void LogErrorWithCodeFromResources(
	string subcategoryResourceName,
	string file,
	int lineNumber,
	int columnNumber,
	int endLineNumber,
	int endColumnNumber,
	string messageResourceName,
	params object[] messageArgs
)

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: System.Object[]

The arguments for formatting the loaded string.

Exception Condition
ArgumentNullException

messageResourceName is null.

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

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

.NET Framework
Available since 2.0
Return to top
Show: