VersionControlServer.GetPendingChanges Method (array<Int32[], Boolean)

When a user adds, deletes, edits, branches or merges a file, these changes are made in their workspace only. The changes are pending until the user checks them into Team Foundation Server. This function gets information about the specified changes pending.

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


Public Function GetPendingChanges ( _
    pendingChangeIds As Integer(), _
    includeDownloadInfo As Boolean _
) As PendingChange()
Dim instance As VersionControlServer 
Dim pendingChangeIds As Integer()
Dim includeDownloadInfo As Boolean 
Dim returnValue As PendingChange()

returnValue = instance.GetPendingChanges(pendingChangeIds, _
public PendingChange[] GetPendingChanges(
    int[] pendingChangeIds,
    bool includeDownloadInfo
array<PendingChange^>^ GetPendingChanges(
    array<int>^ pendingChangeIds, 
    bool includeDownloadInfo
public function GetPendingChanges(
    pendingChangeIds : int[], 
    includeDownloadInfo : boolean
) : PendingChange[]


  • includeDownloadInfo
    Type: System.Boolean

    If you set includeDownloadInfo to true, the returned PendingChange objects will contain information required to download files. This makes the initial GetPendingChange call slower, so should only be used if you want to download files using the returned object.

Return Value

Type: array<Microsoft.TeamFoundation.VersionControl.Client.PendingChange[]
Each returned PendingChange object contains the name of the affected file or folder, and the type of change. Both a server name (such as $/CmdLine/parser.cs) and a local name (such as C:\code\CmdLine\parser.cs) are included, and they may have nothing in common. (If you pended a Rename, for instance, the server path contains the old filename; the local path contains the new filename.) The ChangeType is a series of bitflags that describe the type of change: add, edit, or other changes. If no change is found that matches the specified ID, the corresponding element in the returned array is null.


If a pending change cannot be found for a specific pending change ID, then the corresponding element in the pending change output array will be null.

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. The overloaded methods set includeDownloadInfo to false.

.NET Framework Security

See Also


VersionControlServer Class

VersionControlServer Members

GetPendingChanges Overload

Microsoft.TeamFoundation.VersionControl.Client Namespace