VersionControlServer.GetPendingChange Method (Int32, Boolean)

Note: This API is now obsolete.

Gets the PendingChange object from the repository, with the specified ID. Also gets information to download files.

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

[ObsoleteAttribute("Method obsolete since TFS 2010. Please use VersionControlServer.QueryPendingSets, VersionControlServer.QueryShelvedChanges or Workspace.GetPendingChanges instead.")]
public PendingChange GetPendingChange(
	int pendingChangeId,
	bool includeDownloadInfo


Type: System.Int32
The PendingChange ID.
Type: System.Boolean
True to get the information needed to download files. Specify false to save bandwidth, if downloading is not necessary.

Return Value

Type: Microsoft.TeamFoundation.VersionControl.Client.PendingChange
The PendingChange that matches the specified ID. Otherwise, null.

Only set includeDownloadInfo to true if you will download the files using the returned information. This method call will be faster and require less bandwidth when includeDownloadInfo is false (default for overloads that do not specify it).

Community Additions