This documentation is archived and is not being maintained.

VersionControlServer.GetPendingSets Method

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 all the pending changes for the passed items, but download information is not included. Without download information the function call is faster, but if you want to download files, you should use the overload method that will allow you to get download information with the returned items.This function cannot return pending changes on deleted items: that can be done with an overload version of the same function.

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

public PendingSet[] GetPendingSets(
	string[] items,
	RecursionType recursion
)

Parameters

items
Type: System.String[]

The paths to query for pending changes. Each string may represent a Team Foundation Server path ($/CmdLine/parse.cs) or a local path (C:\Code\CmdLine\parse.cs), in the latter case, the local path is mapped to a server path via a workspace. If any string in the list is null, an exception occurs. Wildcards are also supported.

recursion
Type: Microsoft.TeamFoundation.VersionControl.Client.RecursionType

The recursion parameter determines what files and folders that you want to get. RecursionType.None examines the passed items only; if you passed in $/CmdLine then you will get pending sets for the folder $/CmdLine. RecursionType.OneLevel examines the passed items and, in the case of folders, their children; if you passed in $/CmdLine you will get pending sets for the files and folders directly inside that folder.

RecursionType.Full examines the full tree; if you passed in $/CmdLine/parser.cs you will get all files called parser.cs inside $/CmdLine or any folder under it.

Return Value

Type: Microsoft.TeamFoundation.VersionControl.Client.PendingSet[]
A PendingSet is a group of pending changes associated with a particular user and workspace. If you pass in one item, and this item has pending changes from three different users, there will be three different pending sets returned. Each set may contain many different pending changes.

Show: