CreateWorkspaceParameters Class

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
Public method CreateWorkspaceParameters Create a new CreateWorkspaceParameters instance to supply data to VersionControlServer.CreateWorkspace.

Top

Properties

  Name Description
Public property 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).
Public property Computer The computer on which the workspace to be created will reside. The default value for this parameter is Workstation.Current.Name.
Public property Folders The initial working folders (mappings) for the workspace to be created. The default value for this parameter is an empty array.
Public property 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.
Public property 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.
Public property 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.
Public property 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).
Public property 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.
Public property WorkspaceName The name of the workspace to be created.
Public property WorkspaceOptions Options for the workspace.

Top

Methods

  Name Description
Public method Equals Determines whether the specified object is equal to the current object. (Inherited from Object.)
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.)
Public method GetHashCode Serves as a hash function for a particular type. (Inherited from Object.)
Public method GetType Gets the Type of the current instance. (Inherited from Object.)
Protected method MemberwiseClone Creates a shallow copy of the current Object. (Inherited from Object.)
Public method 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.

See Also

Reference

Microsoft.TeamFoundation.VersionControl.Client Namespace