CreateWorkspaceParameters Class

Article
07/02/2014

A CreateWorkspaceParameters object encapsulates all the information that is required to call VersionControlServer.CreateWorkspace.

Inheritance Hierarchy

System.Object
Microsoft.TeamFoundation.VersionControl.Client.CreateWorkspaceParameters

Namespace: Microsoft.TeamFoundation.VersionControl.Client
Assembly: Microsoft.TeamFoundation.VersionControl.Client (in Microsoft.TeamFoundation.VersionControl.Client.dll)

Syntax

'Declaration
Public Class CreateWorkspaceParameters

public class CreateWorkspaceParameters

public ref class CreateWorkspaceParameters

type CreateWorkspaceParameters =  class end

public class CreateWorkspaceParameters

The CreateWorkspaceParameters type exposes the following members.

Constructors

	Name	Description
	CreateWorkspaceParameters	Create a new CreateWorkspaceParameters instance to supply data to VersionControlServer.CreateWorkspace.

Top

Properties

	Name	Description
	Comment	A descriptive comment to be associated with the workspace to be created. The default value for this parameter is the empty string (String.Empty).
	Computer	The computer on which the workspace to be created will reside. The default value for this parameter is Workstation.Current.Name.
	Folders	The initial working folders (mappings) for the workspace to be created. The default value for this parameter is an empty array.
	Location	Set this value to WorkspaceLocation.Local to indicate the workspace to be created should be a local workspace. Set this value to WorkspaceLocation.Server to indicate the workspace to be created should be a server-side or "traditional" workspace, which is the only kind of workspace backward compatible with TFS 2005-2010 clients. The default value if not provided is determined from the server.
	OwnerDisplayName	The owner display name of the workspace to be created. The default value for this parameter is RepositoryConstants.AuthenticatedUser (or "."), which indicates that the server should create the workspace on behalf of the calling user. If you are not sure who this resolves to, the value of the AuthorizedUser property of the VersionControlServer object gives the full display name form of the calling user.
	OwnerName	The owner name of the workspace to be created. The default value for this parameter is RepositoryConstants.AuthenticatedUser (or "."), which indicates that the server should create the workspace on behalf of the calling user. If you are not sure who this resolves to, the value of the AuthorizedUser property of the VersionControlServer object gives the full display name form of the calling user.
	PermissionProfile	The workspace permission profile for the workspace to be created. A workspace permission profile is a template for the workspace's access control list. By default, the value for this parameter is WorkspacePermissionProfile.BuiltInProfiles[(int)WorkspacePermissionProfile.BuiltInIndexes.Private], which only grants permission to the owner of the workspace (a 'private' workspace).
	RemoveUnparentedCloaks	If true, any cloaks in the initial working folders (this.Folders) which are not parented by a mapping are removed silently. The default value is false.
	WorkspaceName	The name of the workspace to be created.
	WorkspaceOptions	Options for the workspace.

Top

Methods

	Name	Description
	Equals	Determines whether the specified object is equal to the current object. (Inherited from Object.)
	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.)
	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.)

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.