Share via

ICancelableTask Interface

  • Reference

Definition

Namespace:
Microsoft.Build.Framework
Assembly:
Microsoft.Build.Framework.dll
Package:
Microsoft.Build.Framework v15.9.20
Package:
Microsoft.Build.Framework v16.11.0
Package:
Microsoft.Build.Framework v17.11.4
Source:
ICancelableTask.cs

Interface for tasks which can be cancelled.

public interface class ICancelableTask : Microsoft::Build::Framework::ITask
public interface ICancelableTask : Microsoft.Build.Framework.ITask
type ICancelableTask = interface
    interface ITask
Public Interface ICancelableTask
Implements ITask
Derived
Implements
ITask

Properties

BuildEngine

This property is set by the build engine to allow a task to call back into it.

(Inherited from ITask)
HostObject

The build engine sets this property if the host IDE has associated a host object with this particular task.

(Inherited from ITask)

Methods

Cancel()

Instructs the task to exit as soon as possible, or to immediately exit if Execute is invoked after this method.
Execute()

This method is called by the build engine to begin task execution. A task uses the return value to indicate whether it was successful. If a task throws an exception out of this method, the engine will automatically assume that the task has failed.

(Inherited from ITask)

Applies to