This documentation is archived and is not being maintained.

VersionControlServer.GetChangeset Method (Int32, Boolean, Boolean)

When a user adds, deletes, edits, branches, or merges a file, these changes are made in their workspace only. When a user then checks in files, all these changes become one changeset which is automically updated on the server to be available to other users. That changeset is associated with a changeset ID which acts as a version number for every updated item. This function gets a detailed description of the specified changeset.

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

public Changeset GetChangeset(
	int changesetId,
	bool includeChanges,
	bool includeDownloadInfo
)

Parameters

changesetId
Type: System.Int32

The numeric ID for the changeset that you want to get.

includeChanges
Type: System.Boolean

If true, the server will include all the specific changes in the changeset; otherwise, only metadata about the changeset itself will be returned.

Note that a changeset can be large, millions of files may be involved. As an alternative to setting this parameter to true and receiving one big array of all the changes, you can use the GetChangesForChangeset method to page through the list and present some of the results to the user before the entire changeset has been getd.

includeDownloadInfo
Type: System.Boolean

If you set includeDownloadInfo to true, the Item objects inside the returned Change objects will contain information required to download files. This makes the initial GetChangeset call slower, so should only be used if you want to download files by using the returned objects.

Return Value

Type: Microsoft.TeamFoundation.VersionControl.Client.Changeset
Returns a Changeset object which specifies details such as user, comment, and (if requested) a sorted list of all the items and how each one was changed.

Only set includeDownloadInfo to true if you want to download the files by using the returned objects. The call will be faster and require less bandwidth when this parameter is set to false. Overload methods use false for includeDownloadInfo.

NoteNote:

Internally, the overloads for GetChangeset use false for includeDownloadInfo.

Show: