VersionControlServer Class
Represents the version control repository.
Inheritance Hierarchy
System.Object
Microsoft.TeamFoundation.VersionControl.Client.VersionControlServer
Namespace: Microsoft.TeamFoundation.VersionControl.Client
Assembly: Microsoft.TeamFoundation.VersionControl.Client (in Microsoft.TeamFoundation.VersionControl.Client.dll)
Syntax
'Declaração
Public NotInheritable Class VersionControlServer
public sealed class VersionControlServer
public ref class VersionControlServer sealed
[<Sealed>]
type VersionControlServer = class end
public final class VersionControlServer
The VersionControlServer type exposes the following members.
Properties
Name | Description | |
---|---|---|
ArtifactProvider | Gets the artifact provider for the server. | |
AuthenticatedUser | Obsolete. Gets the identity that the server used to authenticate the user. | |
AuthorizedUser | Gets the user who is authorized to use the specified server. | |
Canceled | Gets or sets a flag that describes whether the user has requested cancellation of the current operation. | |
ClientTracing | Gets or sets the tracing level for all instances of VersionControlServer. | |
CurrentCommand | Gets or sets the command that is executed on the client side. | |
MaxBackgroundThreads | Gets or sets the maximum number of background threads that will be used for file uploads and downloads. | |
MaxResults | Gets or sets the maximum number of Get operation results that the server may return from a single call. | |
ServerGuid | Gets the GUID of the Version Control Server repository. | |
SupportedFeatures | Gets the features supported by the Version Control Server. | |
TeamFoundationServer | Obsolete. Gets the TeamFoundationServer that owns this VersionControlServer instance. | |
TeamProjectCollection | Gets the TfsTeamProjectCollection that owns this VersionControlServer instance. |
Top
Methods
Name | Description | |
---|---|---|
AddProxy(String) | Adds a new proxy server record. | |
AddProxy(ProxyInfo) | Adds a new proxy server record. | |
AddProxy(String, String) | Adds a new proxy server record. | |
CheckInShelveset(ShelvesetCheckInParameters) | Submit an existing Shelveset for check in to the repository. | |
CheckInShelveset(String, String) | Submit an existing Shelveset for check in to the repository. | |
ConfigureProxy(String) | Configures the specified proxy URL. | |
ConfigureProxy(ProxyInfo) | Configures the specified proxy. | |
CreateBranch(String, String, VersionSpec) | Creates a branch on the server and checks it in without downloading the branch to the client. | |
CreateBranch(String, String, VersionSpec, String, String, CheckinNote, PolicyOverrideInfo, array<Mapping[]) | Creates a branch on the server and checks it in without downloading the branch to the client. | |
CreateBranchObject | Creates a BranchObject in Team Foundation Server. | |
CreateLabel | Create or update a label. | |
CreateTeamProjectFolder | Creates a team project root folder and configures it. | |
CreateWorkspace(String) | Creates a new Workspace. | |
CreateWorkspace(String, String) | Creates a new Workspace. | |
CreateWorkspace(String, String, String) | Creates a new Workspace. | |
CreateWorkspace(String, String, String, array<WorkingFolder[]) | Creates a new Workspace. | |
CreateWorkspace(String, String, String, array<WorkingFolder[], String) | Creates a new Workspace. | |
CreateWorkspace(String, String, String, array<WorkingFolder[], String, Boolean) | Creates a new Workspace. | |
CreateWorkspace(String, String, String, array<WorkingFolder[], String, WorkspacePermissionProfile, Boolean) | Creates a new Workspace. | |
DeleteBranchObject | Deletes a BranchObject and all associated properties from Team Foundation Server. | |
DeleteLabel | Deletes the label with the specified name and scope. | |
DeleteProxy | Deletes the proxy server record for the specified proxy URL. | |
DeleteShelveset(Shelveset) | Removes a Shelveset from the server. | |
DeleteShelveset(String, String) | Removes a Shelveset from the server. | |
DeleteWorkspace | Deletes the Shelveset that has the specified name and owner. | |
Destroy(ItemSpec, VersionSpec, VersionSpec, DestroyFlags) | Permanently deletes the subtree, starting at the specified item. | |
Destroy(ItemSpec, VersionSpec, VersionSpec, DestroyFlags, array<PendingSet[]%, array<PendingSet[]%) | Permanently deletes the subtree, starting at the specified item. | |
DownloadFile(String, String) | Downloads the latest version of a file from the server to a local file. | |
DownloadFile(String, Int32, VersionSpec, String) | Downloads the specified version of a file from the server to a local file. | |
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.) | |
GetAllCheckinNoteFieldNames | Gets an array of all the check-in note fields used in this database. | |
GetAllTeamProjects | Gets the TeamProject objects in the repository. | |
GetBestProxies | Gets a list of recommended proxy servers returned in preferential order for the given site. | |
GetBranchHistory | Gets the branch history of the requested items. | |
GetChangeset(Int32) | Gets the details of a Changeset (comment, changes, etc.). | |
GetChangeset(Int32, Boolean, Boolean) | Gets the details of a Changeset (comment, changes, etc.). | |
GetChangeset(Int32, Boolean, Boolean, Boolean) | Gets the details of a Changeset (comment, changes, etc.). | |
GetChangeset(Int32, Boolean, Boolean, array<String[]) | Gets the details of a Changeset (comment, changes, etc.). | |
GetChangesetProperty(Int32, String) | Gets the property value of a Changeset specified by Changeset ID and property name filter. | |
GetChangesetProperty(Int32, array<String[]) | Gets the property value of a Changeset specified by Changeset ID and an array of property name filters. | |
GetChangesForChangeset(Int32, Boolean, Int32, ItemSpec) | Gets the Change objects within a Changeset. Allows the caller to page changes back from the server. | |
GetChangesForChangeset(Int32, Boolean, Int32, ItemSpec, array<String[]) | Gets the changes within a Changeset. Allows the caller to page changes back from the server. | |
GetChangesForChangeset(Int32, Boolean, Int32, ItemSpec, array<String[], Boolean) | Gets the changes within a Changeset. Allows the caller to page changes back from the server. | |
GetCheckinNoteDefinitions | Gets the CheckinNoteFieldDefinition objects supported for CheckinNote data. | |
GetCheckinNoteDefinitionsForServerPaths | Gets the CheckinNoteFieldDefinition objects supported for CheckinNote data. | |
GetCheckinPoliciesForServerPaths | Gets the CheckinNoteFieldDefinition supported for CheckinNote data. | |
GetEffectiveGlobalPermissions | Gets the global permissions of a user. | |
GetEffectivePermissions | Gets the permissions of a user for a particular Item. | |
GetExtendedItems(String, DeletedState, ItemType) | Gets an array of ExtendedItem objects in the repository that match the specified criteria. | |
GetExtendedItems(array<ItemSpec[], DeletedState, ItemType) | Gets an array of ExtendedItem objects in the repository that match the specified criteria, for each ItemSpec. | |
GetExtendedItems(array<ItemSpec[], DeletedState, ItemType, GetItemsOptions) | Gets an array of ExtendedItem objects in the repository that match the specified criteria, for each ItemSpec. | |
GetFileTypes | Gets the array of FileType objects registered on the server. | |
GetGlobalPermissions | Gets the global permissions of the selected users in the repository. | |
GetHashCode | Serves as a hash function for a particular type. (Inherited from Object.) | |
GetItem(String) | Gets the Item at the specified path. | |
GetItem(Int32, Int32) | Gets an Item from the repository, based on itemId and changesetNumber. | |
GetItem(String, VersionSpec) | Gets the Item at the specified path. | |
GetItem(Int32, Int32, GetItemsOptions) | Gets an Item from the repository, based on itemId, changesetNumber, and options. | |
GetItem(Int32, Int32, Boolean) | Gets an Item from the repository, based on itemId and changesetNumber. | |
GetItem(String, VersionSpec, DeletedState) | Gets the Item at the specified path. | |
GetItem(String, VersionSpec, Int32) | Gets the Item at the specified path. | |
GetItem(String, VersionSpec, DeletedState, GetItemsOptions) | Gets the Item at the specified path. | |
GetItem(String, VersionSpec, DeletedState, Boolean) | Gets the Item at the specified path. | |
GetItem(String, VersionSpec, Int32, GetItemsOptions) | Gets the Item at the specified path. | |
GetItem(String, VersionSpec, Int32, Boolean) | Gets the Item at the specified path. | |
GetItems(String) | Gets an array of Item objects from repository that match the specified path. | |
GetItems(array<Int32[], Int32) | Gets an array of Item objects from repository, based on itemIds and changesetNumber. | |
GetItems(String, RecursionType) | Gets an array of Item objects from repository that match the specified path. | |
GetItems(array<Int32[], Int32, GetItemsOptions) | Gets an array of Item objects from repository, based on itemIds and changesetNumber. | |
GetItems(array<Int32[], Int32, Boolean) | Gets an array of Item objects from repository, based on itemIds and changesetNumber. | |
GetItems(String, VersionSpec, RecursionType) | Gets an array of Item objects from repository that match the specified path. | |
GetItems(array<ItemSpec[], VersionSpec, DeletedState, ItemType) | Gets an array of Item objects in the repository that match the specified path and version. | |
GetItems(String, VersionSpec, RecursionType, DeletedState, ItemType) | Gets an array of Item objects from repository that match the specified path. | |
GetItems(ItemSpec, VersionSpec, DeletedState, ItemType, GetItemsOptions) | Gets an array of Item objects in the repository that match the specified path and version. | |
GetItems(ItemSpec, VersionSpec, DeletedState, ItemType, Boolean) | Gets an array of Item objects in the repository that match the specified path and version. | |
GetItems(array<ItemSpec[], VersionSpec, DeletedState, ItemType, GetItemsOptions) | Gets an array of Item objects in the repository that match the specified path and version. | |
GetItems(array<ItemSpec[], VersionSpec, DeletedState, ItemType, Boolean) | Gets an array of Item objects in the repository that match the specified path and version. | |
GetItems(String, VersionSpec, RecursionType, DeletedState, ItemType, Boolean) | Gets an array of Item objects from repository that match the specified path. | |
GetLatestChangesetId | Gets the Changeset ID for the latest Changeset in the repository. | |
GetMergeCandidates(ItemSpec, String) | Gets the candidates for merging between the requested items. | |
GetMergeCandidates(String, String, RecursionType) | Gets the candidates for merging between the requested items. | |
GetPendingChange(Int32) | Obsolete. Gets the PendingChange object from the repository, with the specified ID. | |
GetPendingChange(Int32, Boolean) | Obsolete. Gets the PendingChange object from the repository, with the specified ID. Also gets information to download files. | |
GetPendingChanges(array<Int32[]) | Obsolete. Gets the PendingChange objects from the repository with the specified IDs. | |
GetPendingChanges(array<Int32[], Boolean) | Obsolete. Gets the PendingChange objects from the repository with the specified IDs. Also gets information to download files. | |
GetPendingSets | Gets the PendingSet objects for the specified query. | |
GetPermissions(array<String[], RecursionType) | Gets the permissions of the specified Items. | |
GetPermissions(array<String[], array<String[], RecursionType) | Gets the permissions of the specified Items. | |
GetProxies() | Gets an array of all configured proxy servers. | |
GetProxies(array<String[]) | Gets an array of proxy server records based on the specified URLs. | |
GetProxy | Gets the record for a proxy server at the specified URL. | |
GetTeamProject | Gets the TeamProject in the repository with the specified name. | |
GetTeamProjectForServerPath | Gets the TeamProject for the specified server path. | |
GetTeamProjectsForServerPaths | Gets the TeamProject objects in the repository with the specified paths. | |
GetType | Gets the Type of the current instance. (Inherited from Object.) | |
GetVersionedItemProperty(ItemSpec, VersionSpec, DeletedState, ItemType, String) | Gets a property value for the specified item. | |
GetVersionedItemProperty(array<ItemSpec[], VersionSpec, DeletedState, ItemType, array<String[]) | Gets a set of property values for the specified items. | |
GetWorkspace(String) | Gets the Workspace that is mapped to the specified local path. | |
GetWorkspace(WorkspaceInfo) | Gets the Workspace associated with the specified WorkspaceInfo object. | |
GetWorkspace(String, String) | Gets the Workspace associated with the specified name and owner. | |
MemberwiseClone | Creates a shallow copy of the current Object. (Inherited from Object.) | |
QueryBranchObjectOwnership(array<Int32[]) | Gets the BranchObjectOwnership objects associated with the specified Changeset IDs. | |
QueryBranchObjectOwnership(array<Int32[], ItemSpec) | Gets the BranchObjectOwnership objects associated with the specified Changeset IDs, constrained by the specified path filter. | |
QueryBranchObjects | Queries a BranchObject. | |
QueryHistory(String, VersionSpec, Int32, RecursionType, String, VersionSpec, VersionSpec, Int32, Boolean, Boolean) | Gets a collection of Changeset objects matching the specified items and versions. | |
QueryHistory(String, VersionSpec, Int32, RecursionType, String, VersionSpec, VersionSpec, Int32, Boolean, Boolean, Boolean) | Gets a collection of Changeset objects matching the specified items and versions. | |
QueryHistory(String, VersionSpec, Int32, RecursionType, String, VersionSpec, VersionSpec, Int32, Boolean, Boolean, Boolean, Boolean) | Gets a collection of Changeset objects matching the specified items and versions. | |
QueryLabels(String, String, String, Boolean) | Queries for an array of VersionControlLabel objects applied to items in the repository. | |
QueryLabels(String, String, String, Boolean, String, VersionSpec) | Queries for an array of VersionControlLabel objects applied to items in the repository. | |
QueryLabels(String, String, String, Boolean, String, VersionSpec, Boolean) | Queries for an array of VersionControlLabel objects applied to items in the repository. | |
QueryMergeRelationships | Gets an array of all items that have a merge relationship to the specified item. | |
QueryMerges(ItemSpec, VersionSpec, ItemSpec, VersionSpec, VersionSpec, VersionSpec) | Gets the merge history of the specified target item with an optional source. | |
QueryMerges(String, VersionSpec, String, VersionSpec, VersionSpec, VersionSpec, RecursionType) | Gets the merge history of the requested item with an optional source. | |
QueryMerges(ItemSpec, VersionSpec, ItemSpec, VersionSpec, VersionSpec, VersionSpec, Boolean) | Gets the merge history of the requested item with an optional source. | |
QueryMerges(String, VersionSpec, String, VersionSpec, VersionSpec, VersionSpec, RecursionType, Boolean) | Gets the merge history of the requested item with an optional source. | |
QueryMergesExtended(ItemSpec, VersionSpec, VersionSpec, VersionSpec) | Gets the merge history for a specific item and version range. | |
QueryMergesExtended(ItemSpec, VersionSpec, VersionSpec, VersionSpec, QueryMergesExtendedOptions) | Gets the merge history for a specific item and version range. | |
QueryMergesWithDetails(String, VersionSpec, Int32, String, VersionSpec, Int32, VersionSpec, VersionSpec, RecursionType) | Gets the merge history with details of the specified target item with an optional source. | |
QueryMergesWithDetails(String, VersionSpec, Int32, String, VersionSpec, Int32, VersionSpec, VersionSpec, RecursionType, Boolean) | Gets the merge history with details of the specified target item with an optional source. | |
QueryPendingSets(array<ItemSpec[], String, String) | Gets the pending changes for the specified query. | |
QueryPendingSets(array<String[], RecursionType, String, String) | Gets the pending changes for the specified query. | |
QueryPendingSets(array<ItemSpec[], String, String, Boolean) | Gets the pending changes for the specified query. | |
QueryRootBranchObjects | Queries all BranchObject objects that have no parent. | |
QueryShelvedChanges(Shelveset) | Gets the shelved changes in the specified Shelveset. | |
QueryShelvedChanges(String, String) | Gets the shelved changes in the specified Shelveset. | |
QueryShelvedChanges(Shelveset, array<ItemSpec[]) | Gets the shelved changes in the specified Shelveset. | |
QueryShelvedChanges(String, String, array<ItemSpec[]) | Gets the shelved changes in the specified Shelveset. | |
QueryShelvedChanges(String, String, array<ItemSpec[], Boolean) | Gets the shelved changes in the specified Shelveset. | |
QueryShelvesets | Queries an array of Shelveset objects with the specified name and/or owner. | |
QueryWorkspaces(String, String, String) | Gets an array of Workspace objects that match the specified name, owner, computer, or any combination of these criteria. | |
QueryWorkspaces(String, String, String, WorkspacePermissions) | Gets an array of Workspace objects that match the specified name, owner, computer, or any combination of these criteria. Also allows filtering by permission. | |
RenameCheckinNoteFieldName | Rename all instances of the specified CheckinNote field to the new specified name for the given team project folder. | |
ServerItemExists(String, ItemType) | Checks to see if the item of the specified path and type exists in the repository. | |
ServerItemExists(String, VersionSpec, DeletedState, ItemType) | Checks to see if the item of the specified path, version, and type exists in the repository. | |
SetChangesetProperty(Int32, array<PropertyValue[]) | Sets a list of PropertyValue objects to a Changeset. | |
SetChangesetProperty(Int32, List<PropertyValue>) | Sets a list of PropertyValue objects to a Changeset. | |
SetChangesetProperty(Int32, String, array<Byte[]) | Sets a PropertyValue object to a Changeset. | |
SetChangesetProperty(Int32, String, Nullable<DateTime>) | Sets a PropertyValue object to a Changeset. | |
SetChangesetProperty(Int32, String, Nullable<Double>) | Sets a PropertyValue object to a Changeset. | |
SetChangesetProperty(Int32, String, Nullable<Int32>) | Sets a of PropertyValue object to a Changeset. | |
SetChangesetProperty(Int32, String, String) | Sets a of PropertyValue object to a Changeset. | |
SetFileTypes | Sets the file types registered on the server. | |
SetGlobalPermissions | Sets the permissions for items in the repository. | |
SetPermissions | Sets the permissions for items in the repository. | |
SetVersionedItemProperty(array<ItemSpec[], VersionSpec, DeletedState, ItemType, array<PropertyValue[]) | Sets a property on an array of versioned items. | |
SetVersionedItemProperty(ItemSpec, VersionSpec, DeletedState, ItemType, String, array<Byte[]) | Sets a property on a versioned item. | |
SetVersionedItemProperty(ItemSpec, VersionSpec, DeletedState, ItemType, String, Nullable<DateTime>) | Sets a property on a versioned item. | |
SetVersionedItemProperty(ItemSpec, VersionSpec, DeletedState, ItemType, String, Nullable<Double>) | Sets a property on a versioned item. | |
SetVersionedItemProperty(ItemSpec, VersionSpec, DeletedState, ItemType, String, Nullable<Int32>) | Sets a property on a versioned item. | |
SetVersionedItemProperty(ItemSpec, VersionSpec, DeletedState, ItemType, String, String) | Sets a property on a versioned items. | |
StripUnsupportedCheckinOptions | Remove unsupported check-in parameters from a CheckInParameters instance. | |
ToString | Returns a string that represents the current object. (Inherited from Object.) | |
TrackMerges(array<Int32[], ItemIdentifier, array<ItemIdentifier[], ItemSpec) | Gets merges that occurred from a source item to a set of target items, for a list of source Changeset IDs. | |
TrackMerges(array<Int32[], ItemIdentifier, array<ItemIdentifier[], ItemSpec, array<String[]%) | Gets merges that occurred from a source item to a set of target items, for a list of source Changeset IDs. | |
TryGetTeamProject | Gets the team project in the repository with the specified name. | |
TryGetTeamProjectForServerPath | Gets the team project for the specified server path. | |
TryGetWorkspace | Gets the workspace that is mapped to the specified local path. Does not throw an exception. | |
UnlabelItem | Removes a label applied to an item. | |
UpdateBranchObject | Updates an existing BranchObject in Team Foundation Server. | |
UpdateUserName | Fixes the display name for the current user on this server. |
Top
Events
Name | Description | |
---|---|---|
AfterWorkItemsUpdated | Raised after updating work items with a check-in. | |
BeforeCheckinPendingChange | Raised before checking in a PendingChange. | |
BeforeDeleteWorkspace | Raised before deleting an existing Workspace. | |
BeforeShelvePendingChange | Raised before shelving a PendingChange. | |
BeforeWorkItemsUpdate | Raised before updating work items with a check-in. | |
BranchObjectCreated | This event is fired when a BranchObject is created. | |
BranchObjectDeleted | This event is fired when a BranchObject is deleted. | |
BranchObjectUpdated | This event is fired when a BranchObject is updated. | |
ChangesetReconciled | Raised after a Workspace was reconciled to a Changeset. | |
CommitCheckin | Raised on the commit of a new check-in. | |
CommitShelveset | Raised on the creation of a new Shelveset. | |
CommittedBranchCreated | This event is fired when a committed branch is created. | |
Conflict | Raised when a Conflict is created. | |
CreatedWorkspace | Raised when a Workspace is created. | |
DeletedShelveset | Raised on the deletion of a Shelveset. | |
DeletedWorkspace | Raised when a Workspace is deleted. | |
Destroyed | This event is fired when a tree or an item is destroyed. | |
GetCompleted | Raised when a get operation completes on a Workspace. | |
Getting | Raised during a get operation. | |
Merging | Raised during a merge operation. | |
NewPendingChange | Raised on the creation of a new PendingChange. | |
NonFatalError | Raised on errors that do not prevent the operation from completing. | |
OperationFinished | This event is sent when an operation, such as pending a set of changes, is finished. | |
OperationStarting | This event is raised when an operation, such as pending a set of changes, begins. | |
PendingChangesChanged | Raised when a workspace's set of pending changes is modified. | |
ResolvedConflict | Raised when a Conflict is resolved. | |
UndonePendingChange | Raised when an existing PendingChange is undone. | |
UnshelveShelveset | Raised when unshelving a Shelveset. | |
UpdatedWorkspace | Raised when an existing Workspace is updated. | |
WorkItemUpdated | Raised when a work item has been updated with a check-in. |
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.