Workspace.GetPendingChanges Method (array<ItemSpec , Boolean, Int32, String, Boolean)

Gets the pending changes for the items and sub-items in this workspace.

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

Syntax

'Declaration
Public Function GetPendingChanges ( _
    itemSpecs As ItemSpec(), _
    includeDownloadInfo As Boolean, _
    pageSize As Integer, _
    lastChange As String, _
    includeMergeSourceInfo As Boolean _
) As PendingChange()
public PendingChange[] GetPendingChanges(
    ItemSpec[] itemSpecs,
    bool includeDownloadInfo,
    int pageSize,
    string lastChange,
    bool includeMergeSourceInfo
)
public:
array<PendingChange^>^ GetPendingChanges(
    array<ItemSpec^>^ itemSpecs, 
    bool includeDownloadInfo, 
    int pageSize, 
    String^ lastChange, 
    bool includeMergeSourceInfo
)
member GetPendingChanges : 
        itemSpecs:ItemSpec[] * 
        includeDownloadInfo:bool * 
        pageSize:int * 
        lastChange:string * 
        includeMergeSourceInfo:bool -> PendingChange[] 
public function GetPendingChanges(
    itemSpecs : ItemSpec[], 
    includeDownloadInfo : boolean, 
    pageSize : int, 
    lastChange : String, 
    includeMergeSourceInfo : boolean
) : PendingChange[]

Parameters

  • includeDownloadInfo
    Type: System.Boolean

    True to include the information that is required to download files; false not to include it.

  • pageSize
    Type: System.Int32

    The maximum number of pending changes to return in this page.

  • lastChange
    Type: System.String

    The server path of the last pending change in the previous page.

  • includeMergeSourceInfo
    Type: System.Boolean

    True to include source information about rename and merge operations.

Return Value

Type: array<Microsoft.TeamFoundation.VersionControl.Client.PendingChange[]
The pending changes for the specified items in this workspace.

Remarks

Set includeDownloadInfo to true only if you will download the files by using the information that is returned. The call will be faster and require less bandwidth when this parameter is false (default for overloads that do not specify it).

For the first page, lastChange should be null. For subsequent pages, the server path of the last pending change in the page should be used.

.NET Framework Security

See Also

Reference

Workspace Class

GetPendingChanges Overload

Microsoft.TeamFoundation.VersionControl.Client Namespace