WorkspaceInfo Class

Contains the properties of a cached local workspace.

Inheritance Hierarchy

System.Object
Microsoft.TeamFoundation.VersionControl.Client.WorkspaceInfo

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

Syntax

'Declaration
Public NotInheritable Class WorkspaceInfo _
    Implements IComparable
public sealed class WorkspaceInfo : IComparable
public ref class WorkspaceInfo sealed : IComparable
[<Sealed>]
type WorkspaceInfo =  
    class 
        interface IComparable 
    end
public final class WorkspaceInfo implements IComparable

The WorkspaceInfo type exposes the following members.

Properties

Name Description
Public property Comment Gets the comment that is associated with this workspace.
Public property Computer Gets the computer where the workspace is located.
Public property DisplayName Gets the formatted display name of the workspace.
Public property LastSavedCheckin Gets or sets the settings that are associated with the last saved check-in try.
Public property Location Indicates the location where data (pending changes, local versions) for this workspace are stored.
Public property MappedPaths Gets the mappings of the workspace.
Public property Name Gets the name of the workspace.
Public property Options Options set on a workspace.
Public property OwnerAliases The aliases of the workspace owner.
Public property OwnerDisplayName The display name of the workspace owner.
Public property OwnerName Gets the owner of the workspace.
Public property QualifiedName This is the formatted unique display name of the workspace.
Public property SecurityToken The security token for the workspace's access control list in the workspace security namespace.
Public property ServerGuid Gets the GUID of the associated server that is running Team Foundation Server.
Public property ServerUri Gets the uniform resource identifier (URI) of the associated server that is running Team Foundation Server.

Top

Methods

Name Description
Public method Equals Compares this WorkspaceInfo instance with another. (Overrides Object.Equals(Object).)
Public method FormatWorkspaceNameForException Formats the conflicting workspace name for exception when a conflict between names occurs.
Public method GetHashCode Gets the hash code for this WorkspaceInfo instance. (Overrides Object.GetHashCode().)
Public method GetType Gets the Type of the current instance. (Inherited from Object.)
Public method GetWorkspace(TeamFoundationServer) Obsolete. Gets the workspace object that matches this WorkspaceInfo instance.
Public method GetWorkspace(TfsTeamProjectCollection) Gets the workspace object that matches this WorkspaceInfo instance.
Public method OwnerNameMatches Returns true if the owner name matches any of the valid owner names for this workspace.
Public method ToString Gets a string that describes this WorkspaceInfo instance. (Overrides Object.ToString().)

Top

Operators

Name Description
Public operatorStatic member Equality Compares two WorkspaceInfo objects.
Public operatorStatic member Inequality Compares two WorkspaceInfo objects.

Top

Explicit Interface Implementations

Name Description
Explicit interface implemetationPrivate method IComparable.CompareTo Compares two workspace information objects, first comparing the server names, and then comparing the workspace names, and finally comparing owners.

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