CreateWorkspaceTask Class

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.

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

public class CreateWorkspaceTask : WorkflowTask

The CreateWorkspaceTask type exposes the following members.

  NameDescription
Public propertyBuildAgentUriProperty that gives the Uri of the BuildAgent for which this task is executing. (Overrides WorkflowTask.BuildAgentUri.)
Public propertyBuildDirectoryThe working directory of the build agent performing the build.
Public propertyBuildEngineITask implementation—BuildEngine property. (Inherited from Task.)
Public propertyBuildUriProperty that gives the URI of the build for which this task is executing. (Overrides Task.BuildUri.)
Public propertyCommentThis is the comment attached to the workspace created by the task.
Protected propertyExtensions (Inherited from WorkflowTask.)
Public propertyHostObjectITask implementation—HostObject property. (Inherited from Task.)
Public propertyNameThis is the name of the workspace that is created.
Public propertyOwnerThis is the owner of the workspace that is created.
Public propertySourcesDirectoryThe sources directory of the build agent performing the build—typically BuildDirectory\..\Sources.
Public propertyTeamFoundationServerUrlProperty that gives the URL of the Team Foundation Server. (Inherited from Task.)
Protected propertyTfsLazy [init] property that gives access to the Team Foundation Server. (Inherited from Task.)
Top

  NameDescription
Public methodEqualsDetermines whether the specified object is equal to the current object. (Inherited from Object.)
Public methodExecuteITask implementation - Execute method. (Inherited from Task.)
Protected methodFinalizeAllows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object.)
Public methodGetHashCodeServes as the default hash function. (Inherited from Object.)
Protected methodGetParameterLog (Inherited from Task.)
Public methodGetTypeGets the Type of the current instance. (Inherited from Object.)
Protected methodLogCustomEventHelper to log a custom event if the task is running within MSBuild. (Inherited from Task.)
Protected methodLogErrorHelper to log an error string if the task is running within MSBuild. (Inherited from Task.)
Protected methodLogErrorEventHelper to log an error event if the task is running within MSBuild. (Inherited from Task.)
Protected methodLogMessage(String)Helper to log a message string if the task is running within MSBuild. (Inherited from Task.)
Protected methodLogMessage(String, MessageImportance)Helper to log a message string if the task is running within MSBuild. (Inherited from Task.)
Protected methodLogMessageEventHelper to log a message event if the task is running within MSBuild. (Inherited from Task.)
Protected methodLogWarningHelper to log a warning string if the task is running within MSBuild. (Inherited from Task.)
Protected methodLogWarningEventHelper to log a warning event if the task is running within MSBuild. (Inherited from Task.)
Protected methodMemberwiseCloneCreates a shallow copy of the current Object. (Inherited from Object.)
Public methodToStringReturns a string that represents the current object. (Inherited from Object.)
Top

Any public static (Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.
Was this page helpful?
(1500 characters remaining)
Thank you for your feedback
Show:
© 2014 Microsoft