This documentation is archived and is not being maintained.

WorkspaceInfo Class

Contains the properties of a cached local workspace.


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

public ref class WorkspaceInfo sealed : IComparable

The WorkspaceInfo type exposes the following members.

Public propertyCommentGets the comment that is associated with this workspace.
Public propertyComputerGets the computer where the workspace is located.
Public propertyDisplayNameGets the formatted display name of the workspace.
Public propertyLastSavedCheckinGets or sets the settings that are associated with the last saved check-in try.
Public propertyLocationIndicates the location where data (pending changes, local versions) for this workspace are stored.
Public propertyMappedPathsGets the mappings of the workspace.
Public propertyNameGets the name of the workspace.
Public propertyOptionsOptions set on a workspace.
Public propertyOwnerAliasesThe aliases of the workspace owner.
Public propertyOwnerDisplayNameThe display name of the workspace owner.
Public propertyOwnerNameGets the owner of the workspace.
Public propertyQualifiedNameThis is the formatted unique display name of the workspace.
Public propertySecurityTokenThe security token for the workspace's access control list in the workspace security namespace.
Public propertyServerGuidGets the GUID of the associated server that is running Team Foundation Server.
Public propertyServerUriGets the uniform resource identifier (URI) of the associated server that is running Team Foundation Server.

Public methodEqualsCompares this WorkspaceInfo instance with another. (Overrides Object::Equals(Object).)
Public methodFormatWorkspaceNameForExceptionFormats the conflicting workspace name for exception when a conflict between names occurs.
Public methodGetHashCodeGets the hash code for this WorkspaceInfo instance. (Overrides Object::GetHashCode().)
Public methodGetTypeGets the Type of the current instance. (Inherited from Object.)
Public methodGetWorkspace(TeamFoundationServer) Obsolete. Gets the workspace object that matches this WorkspaceInfo instance.
Public methodGetWorkspace(TfsTeamProjectCollection)Gets the workspace object that matches this WorkspaceInfo instance.
Public methodOwnerNameMatchesReturns true if the owner name matches any of the valid owner names for this workspace.
Public methodToStringGets a string that describes this WorkspaceInfo instance. (Overrides Object::ToString().)

Public operatorStatic memberEqualityCompares two WorkspaceInfo objects.
Public operatorStatic memberInequalityCompares two WorkspaceInfo objects.

Explicit interface implemetationPrivate methodIComparable::CompareToCompares two workspace information objects, first comparing the server names, and then comparing the workspace names, and finally comparing owners.

Any public static (Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.