DataTask Class

Abstract base class for tasks that support the database features of Visual Studio.

Inheritance Hierarchy

System.Object
  Microsoft.Build.Utilities.Task
    Microsoft.Data.Schema.Tasks.DataTask
      Microsoft.Data.Schema.Tasks.DataGeneratorTask
      Microsoft.Data.Schema.Tasks.DBBuildTask
      Microsoft.Data.Schema.Tasks.DBDeployTask
      Microsoft.Data.Schema.Tasks.DBSetupDeployTask
      Microsoft.Data.Schema.Tasks.Sql.SqlClrDeployTask
      Microsoft.Data.Schema.Tasks.StaticCodeAnalysisTask

Namespace:  Microsoft.Data.Schema.Tasks
Assembly:  Microsoft.Data.Schema.Tasks (in Microsoft.Data.Schema.Tasks.dll)

Syntax

'Declaration
Public MustInherit Class DataTask _
    Inherits Task _
    Implements ICancelableTask, ITask

public abstract class DataTask : Task, 
    ICancelableTask, ITask

public ref class DataTask abstract : public Task, 
    ICancelableTask, ITask

[<AbstractClass>]
type DataTask =  
    class
        inherit Task
        interface ICancelableTask
        interface ITask
    end

public abstract class DataTask extends Task implements ICancelableTask, ITask

The DataTask type exposes the following members.

Constructors

	Name	Description
	DataTask	Initializes a new instance of the DataTask class.

Top

Properties

	Name	Description
	BuildEngine	Gets or sets the instance of the IBuildEngine object used by the task. (Inherited from Task.)
	BuildEngine2	Gets the instance of the IBuildEngine2 object used by the task. (Inherited from Task.)
	BuildEngine3	Gets the instance of the IBuildEngine3 object used by the task. (Inherited from Task.)
	HelpKeywordPrefix	Gets or sets the prefix used to compose Help keywords from resource names. (Inherited from Task.)
	HostObject	Gets or sets the host object associated with the task. (Inherited from Task.)
	IsCanceled	Gets a value that indicates whether the task was canceled.
	Log	Gets an instance of a TaskLoggingHelper class containing task logging methods. (Inherited from Task.)
	TaskResources	Gets or sets the culture-specific resources associated with the task. (Inherited from Task.)

Top

Methods

	Name	Description
	Equals	Determines whether the specified Object is equal to the current Object. (Inherited from Object.)
	Execute	When overridden in a derived class, executes the task. (Inherited from Task.)
	Finalize	Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object.)
	GetHashCode	Serves as a hash function for a particular type. (Inherited from Object.)
	GetType	Gets the Type of the current instance. (Inherited from Object.)
	MemberwiseClone	Creates a shallow copy of the current Object. (Inherited from Object.)
	ToString	Returns a string that represents the current object. (Inherited from Object.)
	WriteError	Outputs the specified error.
	WriteErrors(String, ICollection<DataSchemaError>)	Outputs the specified list of errors.
	WriteErrors(String, ErrorManager, Object)	Outputs the errors that are contained in the list of error categories.

Top

Events

	Name	Description
	Canceled	Raised when the event is canceled.

Top

Explicit Interface Implementations

	Name	Description
	ICancelableTask.Cancel	Cancels the active operation.

Top

Thread Safety

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

See Also

Reference

Microsoft.Data.Schema.Tasks Namespace