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)

Syntax

'Declaration
<ObsoleteAttribute("Method obsolete since TFS 2010. Please use VersionControlServer.QueryPendingSets, VersionControlServer.QueryShelvedChanges or Workspace.GetPendingChanges instead.")> _
Public Function GetPendingChange ( _
    pendingChangeId As Integer, _
    includeDownloadInfo As Boolean _
) As PendingChange
[ObsoleteAttribute("Method obsolete since TFS 2010. Please use VersionControlServer.QueryPendingSets, VersionControlServer.QueryShelvedChanges or Workspace.GetPendingChanges instead.")]
public PendingChange GetPendingChange(
    int pendingChangeId,
    bool includeDownloadInfo
)
[ObsoleteAttribute(L"Method obsolete since TFS 2010. Please use VersionControlServer.QueryPendingSets, VersionControlServer.QueryShelvedChanges or Workspace.GetPendingChanges instead.")]
public:
PendingChange^ GetPendingChange(
    int pendingChangeId, 
    bool includeDownloadInfo
)
[<ObsoleteAttribute("Method obsolete since TFS 2010. Please use VersionControlServer.QueryPendingSets, VersionControlServer.QueryShelvedChanges or Workspace.GetPendingChanges instead.")>]
member GetPendingChange : 
        pendingChangeId:int * 
        includeDownloadInfo:bool -> PendingChange
public function GetPendingChange(
    pendingChangeId : int, 
    includeDownloadInfo : boolean
) : PendingChange

Parameters

  • includeDownloadInfo
    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.

Remarks

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).

.NET Framework Security

See Also

Reference

VersionControlServer Class

GetPendingChange Overload

Microsoft.TeamFoundation.VersionControl.Client Namespace