Export (0) Print
Expand All

Error Class

This API supports the .NET Framework infrastructure and is not intended to be used directly from your code.

Implements the Error task. Use the Error element in your project file to create and execute this task. For usage and parameter information, see Delete Task.

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

public sealed class Error : TaskExtension

The Error type exposes the following members.

  NameDescription
Public methodErrorInfrastructure. Initializes a new instance of the Error class.
Top

  NameDescription
Public propertyBuildEngineGets or sets the instance of the IBuildEngine object used by the task. (Inherited from Task.)
Public propertyBuildEngine2Gets the instance of the IBuildEngine2 object used by the task. (Inherited from Task.)
Public propertyBuildEngine3Gets the instance of the IBuildEngine3 object used by the task. (Inherited from Task.)
Public propertyBuildEngine4Gets the instance of the IBuildEngine4 object used by the task. (Inherited from Task.)
Public propertyCodeInfrastructure. Gets or sets the error code to associate with the error.
Public propertyFileRelevant file if any. If none is provided, the file containing the Error task will be used.
Public propertyHelpKeywordInfrastructure. Gets or sets the Help keyword to associate with the error.
Public propertyHostObjectGets or sets the host object associated with the task. (Inherited from Task.)
Public propertyLogInfrastructure. Gets an instance of a TaskLoggingHelperExtension containing task logging methods. (Inherited from TaskExtension.)
Public propertyTextInfrastructure. Gets or sets the error text.
Top

  NameDescription
Public methodEquals(Object)Determines whether the specified object is equal to the current object. (Inherited from Object.)
Public methodExecuteInfrastructure. Executes the Error task - logs an error and stops the build. (Overrides Task.Execute().)
Public methodGetHashCodeServes as the default hash function. (Inherited from Object.)
Public methodGetTypeGets the Type of the current instance. (Inherited from Object.)
Public methodToStringReturns a string that represents the current object. (Inherited from Object.)
Top

.NET Framework

Supported in: 4.5.2, 4.5.1, 4.5, 4, 3.5, 3.0, 2.0

Windows 8.1, Windows Server 2012 R2, Windows 8, Windows Server 2012, Windows 7, Windows Vista SP2, Windows Server 2008 (Server Core Role not supported), Windows Server 2008 R2 (Server Core Role supported with SP1 or later; Itanium not supported)

The .NET Framework does not support all versions of every platform. For a list of the supported versions, see .NET Framework System Requirements.

Any public static (Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.
Show:
© 2014 Microsoft