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 | |
---|---|---|
Comment | Gets the comment that is associated with this workspace. | |
Computer | Gets the computer where the workspace is located. | |
DisplayName | Gets the formatted display name of the workspace. | |
LastSavedCheckin | Gets or sets the settings that are associated with the last saved check-in try. | |
Location | Indicates the location where data (pending changes, local versions) for this workspace are stored. | |
MappedPaths | Gets the mappings of the workspace. | |
Name | Gets the name of the workspace. | |
Options | Options set on a workspace. | |
OwnerAliases | The aliases of the workspace owner. | |
OwnerDisplayName | The display name of the workspace owner. | |
OwnerName | Gets the owner of the workspace. | |
QualifiedName | This is the formatted unique display name of the workspace. | |
SecurityToken | The security token for the workspace's access control list in the workspace security namespace. | |
ServerGuid | Gets the GUID of the associated server that is running Team Foundation Server. | |
ServerUri | Gets the uniform resource identifier (URI) of the associated server that is running Team Foundation Server. |
Top
Methods
Name | Description | |
---|---|---|
Equals | Compares this WorkspaceInfo instance with another. (Overrides Object.Equals(Object).) | |
FormatWorkspaceNameForException | Formats the conflicting workspace name for exception when a conflict between names occurs. | |
GetHashCode | Gets the hash code for this WorkspaceInfo instance. (Overrides Object.GetHashCode().) | |
GetType | Gets the Type of the current instance. (Inherited from Object.) | |
GetWorkspace(TeamFoundationServer) | Obsolete. Gets the workspace object that matches this WorkspaceInfo instance. | |
GetWorkspace(TfsTeamProjectCollection) | Gets the workspace object that matches this WorkspaceInfo instance. | |
OwnerNameMatches | Returns true if the owner name matches any of the valid owner names for this workspace. | |
ToString | Gets a string that describes this WorkspaceInfo instance. (Overrides Object.ToString().) |
Top
Operators
Name | Description | |
---|---|---|
Equality | Compares two WorkspaceInfo objects. | |
Inequality | Compares two WorkspaceInfo objects. |
Top
Explicit Interface Implementations
Name | Description | |
---|---|---|
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.