CreateWorkspaceTask Class

Article
2013-11-19

This task is used to create a workspace using an existing workspace template file. It modifies the local paths based on the [LocalPath] property of the task.

Inheritance Hierarchy

System.Object
  Microsoft.TeamFoundation.Build.Tasks.Task
    Microsoft.TeamFoundation.Build.Tasks.WorkflowTask
      Microsoft.TeamFoundation.Build.Tasks.CreateWorkspaceTask

Namespace: Microsoft.TeamFoundation.Build.Tasks
Assembly: Microsoft.TeamFoundation.Build.ProcessComponents (in Microsoft.TeamFoundation.Build.ProcessComponents.dll)

Syntax

'Declaration
Public Class CreateWorkspaceTask _
    Inherits WorkflowTask

public class CreateWorkspaceTask : WorkflowTask

public ref class CreateWorkspaceTask : public WorkflowTask

type CreateWorkspaceTask =  
    class 
        inherit WorkflowTask 
    end

public class CreateWorkspaceTask extends WorkflowTask

The CreateWorkspaceTask type exposes the following members.

Constructors

	Name	Description
	CreateWorkspaceTask

Top

Properties

	Name	Description
	BuildAgentUri	(Overrides WorkflowTask.BuildAgentUri.)
	BuildDirectory	The working directory of the build agent performing the build.
	BuildEngine	ITask implementation—[BuildEngine] property. (Inherited from Task.)
	BuildUri	Property that gives the URI of the build for which this task is executing. (Overrides Task.BuildUri.)
	Comment	This is the comment attached to the workspace created by the task.
	Extensions	(Inherited from WorkflowTask.)
	HostObject	ITask implementation—[HostObject] property. (Inherited from Task.)
	Name	This is the name of the workspace that is created.
	Owner	This is the owner of the workspace that is created.
	SourcesDirectory	The sources directory of the build agent performing the build—typically BuildDirectory\..\Sources.
	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.)
	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.)
	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.

Share via