VersionControlServer.GetChangeset Method (Int32) (Microsoft.TeamFoundation.VersionControl.Client)

GetChangeset Method (Int32)

Collapse All

Language Filter

This page is specific to

Microsoft Visual Studio 2008/.NET Framework 3.5

Other versions are also available for the following:

Microsoft Visual Studio 2005/.NET Framework 2.0

Reference for Team Foundation Server SDK

VersionControlServer..::.GetChangeset Method (Int32)

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, 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, but download information is not included in the changeset. This procedure makes the function call faster, but if you want to download files, you should use one of the overload methods that will allow you to get download information with the returned items.

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

Syntax

Visual Basic (Declaration)

Public Function GetChangeset ( _
    changesetId As Integer _
) As Changeset

Visual Basic (Usage)

Dim instance As VersionControlServer
Dim changesetId As Integer
Dim returnValue As Changeset

returnValue = instance.GetChangeset(changesetId)

public Changeset GetChangeset(
    int changesetId
)

Visual C++

public:
Changeset^ GetChangeset(
    int changesetId
)

JScript

public function GetChangeset(
    changesetId : int
) : Changeset

Parameters

changesetId: Type: System..::.Int32
The numeric ID for the changeset that you want to get.

Return Value

Type: Microsoft.TeamFoundation.VersionControl.Client..::.Changeset
A Changeset object is returned that specifies details such as the user, comment, and a sorted list of all the items and how each one was changed. Note that a changeset can be large, millions of files may be involved. As an alternative to receiving a 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 is getd.

Permissions

Full trust for the immediate caller. This member cannot be used by partially trusted code. For more information, see Using Libraries from Partially Trusted Code.

Reference

VersionControlServer Class

VersionControlServer Members

GetChangeset Overload

Microsoft.TeamFoundation.VersionControl.Client Namespace