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

'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
	CacheEnabled	Gets a flag that describes whether the cache is enabled.
	Current	Gets the workstation instance that represents the current machine.
	GetLatestOnCheckout	Gets or sets a flag that describes whether to get the latest version of an item on checkout.
	InstalledPolicyTypes	Gets the array of installed policy types on this machine.
	Name	Gets the name of this workstation.
	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.
	PagedCheckinPageSize	Gets or sets maximum number of pending changes used during paged check-in and paged pending change acquisition.

Top

Methods

	Name	Description
	EnsureUpdateWorkspaceInfoCache(VersionControlServer, String)	Ensures that the workspace info cache is updated.
	EnsureUpdateWorkspaceInfoCache(VersionControlServer, String, TimeSpan)	Makes sure that the workspace info cache is updated.
	Equals	Determines whether the specified Object is equal to the current Object. (Inherited from Object.)
	Finalize	Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object.)
	GetAllLocalWorkspaceInfo	Gets an array of all cached local workspace info objects.
	GetHashCode	Serves as a hash function for a particular type. (Inherited from Object.)
	GetLocalWorkspaceInfo(String)	Gets the cached local workspace info for the workspace that contains the specified path.
	GetLocalWorkspaceInfo(VersionControlServer, String, String)	Gets the cached local workspace info for the specified workspace.
	GetLocalWorkspaceInfoRecursively	Gets the array of workspace info objects at or below the specified path.
	GetType	Gets the Type of the current instance. (Inherited from Object.)
	IsExplicitlyMapped	Checks whether the specified path is the root mapping in a workspace.
	IsMapped	Checks whether the specified path is mapped in a workspace.
	MemberwiseClone	Creates a shallow copy of the current Object. (Inherited from Object.)
	QueryLocalWorkspaceInfo	Get an array of WorkspaceInfo objects that match the specified parameters.
	ReloadCache	Forces a reload of the cache on disk.
	RemoveCachedWorkspaceInfo(VersionControlServer)	Removes the workspaces that are associated with the specified repository from the cache.
	RemoveCachedWorkspaceInfo(VersionControlServer, String)	Removes the workspaces that are associated with the specified repository from the cache.
	RemoveCachedWorkspaceInfo(Uri, String, String)	Removes the specified workspace from the cache.
	ToString	Returns a string that represents the current object. (Inherited from Object.)
	UpdateServerUriReferences	Updates the cache to reference the specified source control repository using the specified uniform resource identifier (URI).
	UpdateWorkspaceInfoCache(VersionControlServer, String)	Updates the cache with the workspace info objects that are associated with the specified repository.
	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