This documentation is archived and is not being maintained.
VersionControlServer Methods
Visual Studio 2013
The VersionControlServer type exposes the following members.
| 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. |
|
CompareLabels | Queries for a list of labels applied to items in 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, 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(VersionControlLabel, LabelItemSpec[], LabelChildOption) | Create or update a label. |
|
CreateLabel(VersionControlLabel, LabelItemSpec[], LabelChildOption, Failure[]) | Creates a label. |
|
CreateTeamProjectFolder | Creates a team project root folder and configures it. |
|
CreateWorkspace(String) | Creates a new Workspace. |
|
CreateWorkspace(CreateWorkspaceParameters) | Creates a new Workspace. |
|
CreateWorkspace(String, String) | Creates a new Workspace. |
|
CreateWorkspace(String, String, String) | Creates a new Workspace. |
|
CreateWorkspace(String, String, String, WorkingFolder[]) | Creates a new Workspace. |
|
CreateWorkspace(String, String, String, WorkingFolder[], String) | Creates a new Workspace. |
|
CreateWorkspace(String, String, String, WorkingFolder[], String, Boolean) | Creates a new Workspace. |
|
CreateWorkspace(String, String, String, 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, PendingSet[], 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.) |
|
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, String[]) | Gets the details of a Changeset (comment, changes, etc.). |
|
GetChangeset(Int32, Boolean, Boolean, String[], String[], String[]) | Gets the details of a Changeset. |
|
GetChangesetProperty(Int32, String) | Gets the property value of a Changeset specified by Changeset ID and property name filter. |
|
GetChangesetProperty(Int32, 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, String[]) | Gets the changes within a Changeset. Allows the caller to page changes back from the server. |
|
GetChangesForChangeset(Int32, Boolean, Int32, ItemSpec, String[], Boolean) | Gets the changes within a Changeset. Allows the caller to page changes back from the server. |
|
GetChangesForChangeset(Int32, Boolean, Int32, ItemSpec, String[], String[], Boolean) | Gets the changes within a Changeset. |
|
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(ItemSpec[], DeletedState, ItemType) | Gets an array of ExtendedItem objects in the repository that match the specified criteria, for each ItemSpec. |
|
GetExtendedItems(ItemSpec[], DeletedState, ItemType, GetItemsOptions) | Gets an array of ExtendedItem objects in the repository that match the specified criteria, for each ItemSpec. |
|
GetExtendedItems(ItemSpec[], DeletedState, ItemType, GetItemsOptions, String[]) | 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 the default hash function. (Inherited from Object.) |
|
GetIdentityDisplayName | Returns the identity display name. |
|
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(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(Int32[], Int32, GetItemsOptions) | Gets an array of Item objects from repository, based on itemIds and changesetNumber. |
|
GetItems(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(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(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(String, VersionSpec, RecursionType, DeletedState, ItemType, Boolean) | Gets an array of Item objects from repository that match the specified path. |
|
GetItems(ItemSpec[], VersionSpec, DeletedState, ItemType, GetItemsOptions, String[], String[]) | |
|
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. |
|
GetMergeCandidates(ItemSpec, String, MergeOptionsEx) | 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(Int32[]) | Obsolete. Gets the PendingChange objects from the repository with the specified IDs. |
|
GetPendingChanges(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(String[], RecursionType) | Gets the permissions of the specified Items. |
|
GetPermissions(String[], String[], RecursionType) | Gets the permissions of the specified Items. |
|
GetProxies() | Gets an array of all configured proxy servers. |
|
GetProxies(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. |
|
GetServerSettingsWithFallback | |
|
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) | Obsolete. Gets a property value for the specified item. |
|
GetVersionedItemProperty(ItemSpec[], VersionSpec, DeletedState, ItemType, String[]) | Obsolete. 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. |
|
QueryBranchObjectOwnership(Int32[]) | Gets the BranchObjectOwnership objects associated with the specified Changeset IDs. |
|
QueryBranchObjectOwnership(Int32[], ItemSpec) | Gets the BranchObjectOwnership objects associated with the specified Changeset IDs, constrained by the specified path filter. |
|
QueryBranchObjects | Queries a BranchObject. |
|
QueryHistory(ItemSpec) | Gets a collection of Changeset objects matching the specified items and versions. |
|
QueryHistory(QueryHistoryParameters) | Gets a collection of Changeset objects matching the specified items and versions. |
|
QueryHistory(String, RecursionType) | Gets a collection of Changeset objects matching the specified items and versions. |
|
QueryHistory(ItemSpec, Int32) | Gets a collection of Changeset objects matching the specified items and versions. |
|
QueryHistory(String, RecursionType, Int32) | Gets a collection of Changeset objects matching the specified items and versions. |
|
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(ItemSpec[], String, String) | Gets the pending changes for the specified query. |
|
QueryPendingSets(String[], RecursionType, String, String) | Gets the pending changes for the specified query. |
|
QueryPendingSets(ItemSpec[], String, String, Boolean) | Gets the pending changes for the specified query. |
|
QueryPendingSets(ItemSpec[], String, String, Boolean, Boolean) | Gets the pending changes for the specified query. |
|
QueryPendingSets(ItemSpec[], String, String, Boolean, Boolean, String[]) | 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, ItemSpec[]) | Gets the shelved changes in the specified Shelveset. |
|
QueryShelvedChanges(String, String, ItemSpec[]) | Gets the shelved changes in the specified Shelveset. |
|
QueryShelvedChanges(String, String, ItemSpec[], Boolean) | Gets the shelved changes in the specified Shelveset. |
|
QueryShelvedChanges(String, String, ItemSpec[], Boolean, String[]) | Gets the shelved changes in the specified Shelveset. |
|
QueryShelvesets(String, String) | Queries an array of Shelveset objects with the specified name and/or owner. |
|
QueryShelvesets(String, String, String[]) | |
|
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. |
|
ResetCheckinDates | Resets the check in dates. |
|
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, 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, 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. |
|
SetServerSettings | Sets the server settings. |
|
SetVersionedItemAttribute(ItemSpec[], VersionSpec, DeletedState, ItemType, PropertyValue[]) | Sets the attributes associated with the versioned item. |
|
SetVersionedItemAttribute(ItemSpec, VersionSpec, DeletedState, ItemType, String, Byte[]) | Sets the attributes associated with the versioned item. |
|
SetVersionedItemAttribute(ItemSpec, VersionSpec, DeletedState, ItemType, String, Nullable<DateTime>) | Sets the attributes associated with the versioned item. |
|
SetVersionedItemAttribute(ItemSpec, VersionSpec, DeletedState, ItemType, String, Nullable<Double>) | Sets the attributes associated with the versioned item. |
|
SetVersionedItemAttribute(ItemSpec, VersionSpec, DeletedState, ItemType, String, Nullable<Int32>) | Sets the attributes associated with the versioned item. |
|
SetVersionedItemAttribute(ItemSpec, VersionSpec, DeletedState, ItemType, String, String) | Sets the attributes associated with the versioned item. |
|
SetVersionedItemProperty(ItemSpec[], VersionSpec, DeletedState, ItemType, PropertyValue[]) | Obsolete. Sets a property on an array of versioned items. |
|
SetVersionedItemProperty(ItemSpec, VersionSpec, DeletedState, ItemType, String, Byte[]) | Obsolete. Sets a property on a versioned item. |
|
SetVersionedItemProperty(ItemSpec, VersionSpec, DeletedState, ItemType, String, Nullable<DateTime>) | Obsolete. Sets a property on a versioned item. |
|
SetVersionedItemProperty(ItemSpec, VersionSpec, DeletedState, ItemType, String, Nullable<Double>) | Obsolete. Sets a property on a versioned item. |
|
SetVersionedItemProperty(ItemSpec, VersionSpec, DeletedState, ItemType, String, Nullable<Int32>) | Obsolete. Sets a property on a versioned item. |
|
SetVersionedItemProperty(ItemSpec, VersionSpec, DeletedState, ItemType, String, String) | Obsolete. 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(Int32[], ItemIdentifier, ItemIdentifier[], ItemSpec) | Gets merges that occurred from a source item to a set of target items, for a list of source Changeset IDs. |
|
TrackMerges(Int32[], ItemIdentifier, ItemIdentifier[], ItemSpec, 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(String, String, ItemSpec[], VersionSpec) | Removes a label applied to an item. |
|
UnlabelItem(String, String, ItemSpec[], VersionSpec, Predicate<Failure>, Failure[]) | Removes a label that is applied to an item. |
|
UpdateBranchObject | Updates an existing BranchObject in Team Foundation Server. |
|
UpdateShelveset | Updates the shelveset. |
|
UpdateUserName | Fixes the display name for the current user on this server. |
Show: