Information
The topic you requested is included in another documentation set. For convenience, it's displayed below. Choose Switch to see the topic in its original location.

CreateWorkspaceParameters Class

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

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

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

public class CreateWorkspaceParameters

The CreateWorkspaceParameters type exposes the following members.

  NameDescription
Public methodCreateWorkspaceParametersCreate a new CreateWorkspaceParameters instance to supply data to VersionControlServer.CreateWorkspace.
Top

  NameDescription
Public propertyCommentA descriptive comment to be associated with the workspace to be created. The default value for this parameter is the empty string (String.Empty).
Public propertyComputerThe computer on which the workspace to be created will reside. The default value for this parameter is Workstation.Current.Name.
Public propertyFoldersThe initial working folders (mappings) for the workspace to be created. The default value for this parameter is an empty array.
Public propertyLocationSet 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 propertyOwnerDisplayNameThe 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 propertyOwnerNameThe 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 propertyPermissionProfileThe 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 propertyRemoveUnparentedCloaksIf 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 propertyWorkspaceNameThe name of the workspace to be created.
Public propertyWorkspaceOptionsOptions for the workspace.
Top

  NameDescription
Public methodEqualsDetermines whether the specified object is equal to the current object. (Inherited from Object.)
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.)
Public methodGetTypeGets the Type of the current instance. (Inherited from Object.)
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