Export (0) Print
Expand All

WorkspaceSpec Class

A utility class for manipulating version control workspace specifications. It contains routines for parsing, formatting, validating, and so on.

System.Object
  Microsoft.TeamFoundation.VersionControl.Common.WorkspaceSpec

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

public static class WorkspaceSpec

The WorkspaceSpec type exposes the following members.

  NameDescription
Public propertyStatic memberOwnerDisambiguationSeparatorEndReturns the end string for the owner disambiguation separator.
Public propertyStatic memberOwnerDisambiguationSeparatorStartReturns the start string for the owner disambiguation separator.
Public propertyStatic memberSeparatorReturns the separator character for WorkspaceSpec.
Top

  NameDescription
Public methodStatic memberCombine(String, String)Builds the qualified workspace name from the separate workspace and owner parts.
Public methodStatic memberCombine(String, String, String)Builds the fully qualified workspace name with owner disambiguation from the separate workspace and owner parts.
Public methodStatic memberIsLegalNameChecks to see whether the workspace name consists only of valid characters and is less than the maximum length and does not contain a workspace separator.
Public methodStatic memberParse(String, String, String, String)Parses a workspace spec of the form Workspace user and returns the two parts. If the user name is not specified (or fully qualified) in the workspace specification, uses information from the defaultUser argument. NOTE: This method may qualified username (e.g. it lacked the domain\ prefix), this routine does not attempt to provide the missing pieces. The caller is responsible for doing this.
Public methodStatic memberParse(String, String, String, String, String, String)Parses a workspace specification of the form Workspace user and returns the two parts. If the user name is not specified (or fully qualified) in the workspace specification, uses information from the defaultUser arguments. NOTE: This method may qualified username (e.g. it lacked the domain\ prefix), this routine does not attempt to provide the missing pieces. The caller is responsible for doing this.
Public methodStatic memberSanitizeProposedNameGiven a proposed name for a shelveset or workspace, truncates it at the maximum length for shelveset and workspace names, and removes invalid characters. Name validation is enforced by the server. The sanitization process for cleaning up a name is current as of the version of this object model.While unlikely, it is possible that if this method is used with a future version of esprtfs, that the name generated may not be valid due to a change in the rules for workspace and shelveset names.
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.
Show:
© 2014 Microsoft