Workstation Class

A class that represents a computer and the Source Control state on it.

Inheritance Hierarchy

System.Object
  Microsoft.TeamFoundation.VersionControl.Client.Workstation

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

Syntax

'Declaration
Public NotInheritable Class Workstation
public sealed class Workstation
public ref class Workstation sealed
[<Sealed>]
type Workstation =  class end
public final class Workstation

The Workstation type exposes the following members.

Properties

  Name Description
Public property AttemptToAutoResolveConflicts Return or set the user's Attempt To Auto Resolve Conflicts preference for this computer
Public propertyStatic member CacheEnabled Gets a flag that describes whether the cache is enabled.
Public propertyStatic member ConfigurationEnabled When true, the configuration directory exists and will be used. When false, either we do not have access to the directory, it does not exist, or it has been set to false by the application, and we'll want to run without the configuration cache.
Public propertyStatic member Current Gets the workstation instance that represents the current computer.
Public property GetLatestOnCheckout Gets or sets a flag that describes whether to receive the latest version of an item on checkout.
Public property InstalledPolicyTypes Gets the array of installed policy types on this computer.
Public property Name Gets the name of this workstation.
Public propertyStatic member OfflineMetadataFileRoot Returns the directory location where workspace local version metadata files are stored.
Public property PagedCheckinMaterializationCap Gets the maximum size of a pending change collection that will be materialized into memory to support check-in policy evaluation, or LastSavedCheckin checkstate storage.
Public property PagedCheckinPageSize Gets or sets maximum number of pending changes used during paged check-in and paged pending change acquisition.

Top

Methods

  Name Description
Public method EnsureUpdateWorkspaceInfoCache(VersionControlServer, String) Ensures that the workspace information cache is updated.
Public method EnsureUpdateWorkspaceInfoCache(VersionControlServer, String, TimeSpan) Makes sure that the workspace information cache is updated.
Public method Equals Determines whether the specified object is equal to the current object. (Inherited from Object.)
Public method GetAllLocalWorkspaceInfo Gets an array of all cached local workspace information objects.
Public method GetHashCode Serves as the default hash function. (Inherited from Object.)
Public method GetLocalItemExclusions Returns the set of local item exclusions for this user on this computer.
Public method GetLocalWorkspaceInfo(String) Gets the cached local workspace information for the workspace that contains the specified path.
Public method GetLocalWorkspaceInfo(Guid, String, String) Given a Team Project Collection instance ID, workspace name, and workspace owner, looks in the local workspace cache to find a corresponding WorkspaceInfo object. Display names are accepted for the workspace owner string, but if the (name, owner) combination is ambiguous, a MultipleWorkspacesFoundException may be thrown. Passing RepositoryConstants.AuthenticatedUser for "workspaceOwner" is not valid, since no context exists to translate it into the authorized user.
Public method GetLocalWorkspaceInfo(VersionControlServer, String, String) Gets the cached local workspace information for the specified workspace.
Public method GetLocalWorkspaceInfoRecursively Gets the array of workspace information objects at or below the specified path.
Public method GetType Gets the Type of the current instance. (Inherited from Object.)
Public method IsExplicitlyMapped Checks whether the specified path is the root mapping in a workspace.
Public method IsMapped Checks whether the specified path is mapped in a workspace.
Public method QueryLocalWorkspaceInfo Get an array of WorkspaceInfo objects that match the specified parameters.
Public method ReloadCache Forces a reload of the cache on disk.
Public method RemoveCachedWorkspaceInfo(VersionControlServer) Removes the workspaces that are associated with the specified repository from the cache.
Public method RemoveCachedWorkspaceInfo(VersionControlServer, String) Removes the workspaces that are associated with the specified repository from the cache.
Public method RemoveCachedWorkspaceInfo(Uri, String, String) Removes the specified workspace from the cache.
Public method RemoveLocalItemExclusion Removes an exclusion from the local item exclusion list.
Public method SetLocalItemExclusions Overwrites the list of local item exclusions with the list passed in.
Public method ToString Returns a string that represents the current object. (Inherited from Object.)
Public method UpdateServerUriReferences Obsolete. Updates the cache to reference the specified source control repository using the specified uniform resource identifier (URI).
Public method UpdateWorkspaceInfoCache(VersionControlServer, String) Updates the cache with the workspace information objects that are associated with the specified repository.
Public method UpdateWorkspaceInfoCache(VersionControlServer, String, array<Workspace[]%) Updates the cache with the workspace information objects that are associated with the specified repository.

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