Partager via


Workstation Class

A class that represents a machine 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

'Déclaration
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 propertyStatic member CacheEnabled Gets a flag that describes whether the cache is enabled.
Public propertyStatic member Current Gets the workstation instance that represents the current machine.
Public property GetLatestOnCheckout Gets or sets a flag that describes whether to get the latest version of an item on checkout.
Public property InstalledPolicyTypes Gets the array of installed policy types on this machine.
Public property Name Gets the name of this workstation.
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 info cache is updated.
Public method EnsureUpdateWorkspaceInfoCache(VersionControlServer, String, TimeSpan) Makes sure that the workspace info cache is updated.
Public method Equals Determines whether the specified Object is equal to the current Object. (Inherited from Object.)
Protected method Finalize Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object.)
Public method GetAllLocalWorkspaceInfo Gets an array of all cached local workspace info objects.
Public method GetHashCode Serves as a hash function for a particular type. (Inherited from Object.)
Public method GetLocalWorkspaceInfo(String) Gets the cached local workspace info for the workspace that contains the specified path.
Public method GetLocalWorkspaceInfo(VersionControlServer, String, String) Gets the cached local workspace info for the specified workspace.
Public method GetLocalWorkspaceInfoRecursively Gets the array of workspace info 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.
Protected method MemberwiseClone Creates a shallow copy of the current Object. (Inherited from Object.)
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 ToString Returns a string that represents the current object. (Inherited from Object.)
Public method UpdateServerUriReferences 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 info objects that are associated with the specified repository.
Public method UpdateWorkspaceInfoCache(VersionControlServer, String, array<Workspace[]%) Updates the cache with the workspace info 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