This documentation is archived and is not being maintained.

Workstation Class

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


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

public sealed class Workstation

The Workstation type exposes the following members.

Public propertyAttemptToAutoResolveConflictsReturn or set the user's Attempt To Auto Resolve Conflicts preference for this computer
Public propertyStatic memberCacheEnabledGets a flag that describes whether the cache is enabled.
Public propertyStatic memberConfigurationEnabledWhen 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 memberCurrentGets the workstation instance that represents the current computer.
Public propertyGetLatestOnCheckoutGets or sets a flag that describes whether to receive the latest version of an item on checkout.
Public propertyInstalledPolicyTypesGets the array of installed policy types on this computer.
Public propertyNameGets the name of this workstation.
Public propertyStatic memberOfflineMetadataFileRootReturns the directory location where workspace local version metadata files are stored.
Public propertyPagedCheckinMaterializationCapGets 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 propertyPagedCheckinPageSizeGets or sets maximum number of pending changes used during paged check-in and paged pending change acquisition.

Public methodEnsureUpdateWorkspaceInfoCache(VersionControlServer, String)Ensures that the workspace information cache is updated.
Public methodEnsureUpdateWorkspaceInfoCache(VersionControlServer, String, TimeSpan)Makes sure that the workspace information cache is updated.
Public methodEqualsDetermines whether the specified object is equal to the current object. (Inherited from Object.)
Public methodGetAllLocalWorkspaceInfoGets an array of all cached local workspace information objects.
Public methodGetHashCodeServes as the default hash function. (Inherited from Object.)
Public methodGetLocalItemExclusionsReturns the set of local item exclusions for this user on this computer.
Public methodGetLocalWorkspaceInfo(String)Gets the cached local workspace information for the workspace that contains the specified path.
Public methodGetLocalWorkspaceInfo(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 methodGetLocalWorkspaceInfo(VersionControlServer, String, String)Gets the cached local workspace information for the specified workspace.
Public methodGetLocalWorkspaceInfoRecursivelyGets the array of workspace information objects at or below the specified path.
Public methodGetTypeGets the Type of the current instance. (Inherited from Object.)
Public methodIsExplicitlyMappedChecks whether the specified path is the root mapping in a workspace.
Public methodIsMappedChecks whether the specified path is mapped in a workspace.
Public methodQueryLocalWorkspaceInfoGet an array of WorkspaceInfo objects that match the specified parameters.
Public methodReloadCacheForces a reload of the cache on disk.
Public methodRemoveCachedWorkspaceInfo(VersionControlServer)Removes the workspaces that are associated with the specified repository from the cache.
Public methodRemoveCachedWorkspaceInfo(VersionControlServer, String)Removes the workspaces that are associated with the specified repository from the cache.
Public methodRemoveCachedWorkspaceInfo(Uri, String, String)Removes the specified workspace from the cache.
Public methodRemoveLocalItemExclusionRemoves an exclusion from the local item exclusion list.
Public methodSetLocalItemExclusionsOverwrites the list of local item exclusions with the list passed in.
Public methodToStringReturns a string that represents the current object. (Inherited from Object.)
Public methodUpdateServerUriReferences Obsolete. Updates the cache to reference the specified source control repository using the specified uniform resource identifier (URI).
Public methodUpdateWorkspaceInfoCache(VersionControlServer, String)Updates the cache with the workspace information objects that are associated with the specified repository.
Public methodUpdateWorkspaceInfoCache(VersionControlServer, String, Workspace[])Updates the cache with the workspace information objects that are associated with the specified repository.

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