Share via


VersionControlServer.GetChangeset Method (Int32, Boolean, Boolean, Boolean)

Gets the details of a Changeset (comment, changes, etc.).

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

Syntax

'Declaration
Public Function GetChangeset ( _
    changesetId As Integer, _
    includeChanges As Boolean, _
    includeDownloadInfo As Boolean, _
    includeSourceRenames As Boolean _
) As Changeset
public Changeset GetChangeset(
    int changesetId,
    bool includeChanges,
    bool includeDownloadInfo,
    bool includeSourceRenames
)
public:
Changeset^ GetChangeset(
    int changesetId, 
    bool includeChanges, 
    bool includeDownloadInfo, 
    bool includeSourceRenames
)
member GetChangeset : 
        changesetId:int * 
        includeChanges:bool * 
        includeDownloadInfo:bool * 
        includeSourceRenames:bool -> Changeset
public function GetChangeset(
    changesetId : int, 
    includeChanges : boolean, 
    includeDownloadInfo : boolean, 
    includeSourceRenames : boolean
) : Changeset

Parameters

  • includeChanges
    Type: System.Boolean

    True to include the changes in the Changeset. False to include only metadata.

  • includeDownloadInfo
    Type: System.Boolean

    True to get the information needed to download files. Specify false to save bandwidth if not necessary.

  • includeSourceRenames
    Type: System.Boolean

    Include rename sources in the changes returned.

Return Value

Type: Microsoft.TeamFoundation.VersionControl.Client.Changeset
A reference to a Changeset object specifying these details.

Remarks

Only set includeDownloadInfo to true if you are going to be downloading the files using the objects that are returned. The call will be faster and require less bandwidth when includeDownloadInfo is false (default for overloads that don't specify it).

.NET Framework Security

See Also

Reference

VersionControlServer Class

GetChangeset Overload

Microsoft.TeamFoundation.VersionControl.Client Namespace