Note
Access to this page requires authorization. You can try signing in or changing directories.
Access to this page requires authorization. You can try changing directories.
This task is used to delete a workspace from an existing workspace template file.
Inheritance Hierarchy
System.Object
Microsoft.TeamFoundation.Build.Tasks.Task
Microsoft.TeamFoundation.Build.Tasks.WorkflowTask
Microsoft.TeamFoundation.Build.Tasks.DeleteWorkspaceTask
Namespace: Microsoft.TeamFoundation.Build.Tasks
Assembly: Microsoft.TeamFoundation.Build.ProcessComponents (in Microsoft.TeamFoundation.Build.ProcessComponents.dll)
Syntax
'Declaration
Public Class DeleteWorkspaceTask _
Inherits WorkflowTask
public class DeleteWorkspaceTask : WorkflowTask
public ref class DeleteWorkspaceTask : public WorkflowTask
type DeleteWorkspaceTask =
class
inherit WorkflowTask
end
public class DeleteWorkspaceTask extends WorkflowTask
The DeleteWorkspaceTask type exposes the following members.
Constructors
| Name | Description | |
|---|---|---|
.gif "Public method") |
DeleteWorkspaceTask |
Top
Properties
| Name | Description | |
|---|---|---|
.gif "Public property") |
BuildAgentUri | Property that gives the Uri of the Build Agent (Inherited from WorkflowTask.) |
|
BuildEngine | ITask implementation—BuildEngine property. (Inherited from Task.) |
|
BuildUri | Property that gives the URI of the build for which this task is executing. Derived classes can override this property to make it required. (Inherited from Task.) |
|
DeleteLocalItems | If true, DeleteWorkspaceTask will attempt to delete all local items—files and folders—before deleting. |
.gif "Protected property") |
Extensions | (Inherited from WorkflowTask.) |
|
HostObject | ITask implementation—HostObject property. (Inherited from Task.) |
|
Name | This is the name of the workspace that is deleted. |
|
TeamFoundationServerUrl | Property that gives the URL of the Team Foundation Server. (Inherited from Task.) |
|
Tfs | Lazy [init] property that gives access to the Team Foundation Server. (Inherited from Task.) |
Top
Methods
| Name | Description | |
|---|---|---|
|
Equals | Determines whether the specified object is equal to the current object. (Inherited from Object.) |
|
Execute | ITask implementation - Execute method. (Inherited from Task.) |
.gif "Protected method") |
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 the default hash function. (Inherited from Object.) |
|
GetParameterLog | (Inherited from Task.) |
|
GetType | Gets the Type of the current instance. (Inherited from Object.) |
|
LogCustomEvent | Helper to log a custom event if the task is running within MSBuild. (Inherited from Task.) |
|
LogError | Helper to log an error string if the task is running within MSBuild. (Inherited from Task.) |
|
LogErrorEvent | Helper to log an error event if the task is running within MSBuild. (Inherited from Task.) |
|
LogMessage(String) | Helper to log a message string if the task is running within MSBuild. (Inherited from Task.) |
|
LogMessage(String, MessageImportance) | Helper to log a message string if the task is running within MSBuild. (Inherited from Task.) |
|
LogMessageEvent | Helper to log a message event if the task is running within MSBuild. (Inherited from Task.) |
|
LogWarning | Helper to log a warning string if the task is running within MSBuild. (Inherited from Task.) |
|
LogWarningEvent | Helper to log a warning event if the task is running within MSBuild. (Inherited from Task.) |
|
MemberwiseClone | Creates a shallow copy of the current Object. (Inherited from Object.) |
|
ToString | Returns a string that represents the current object. (Inherited from Object.) |
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.