This documentation is archived and is not being maintained.

VersionControlServer.QueryShelvedChanges Method (String, String, ItemSpec[])

Shelving enables you to take a batch of pending changes and set it aside as a named shelveset. The changes in a shelveset can be restored later into your workspace or into another user's workspace. This function gets all the changes for the specified shelveset and owner, 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.

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

public PendingSet[] QueryShelvedChanges(
	string shelvesetName,
	string shelvesetOwner,
	ItemSpec[] itemSpecs


Type: System.String

The shelveset name (may be null).

Type: System.String

The user name (may be null), which is the shelveset owner if the shelveset name is not null.

Type: Microsoft.TeamFoundation.VersionControl.Client.ItemSpec[]

If itemSpecs is set to null, all pending changes in the shelveset are returned. If itemSpecs contains one or more files and folders, only changes to those items are returned. Note that each ItemSpec contains a RecursionType so that it may indicate one item, all the items in a folder, or all the items in a tree. Wildcards are also supported.

Return Value

Type: Microsoft.TeamFoundation.VersionControl.Client.PendingSet[]
A PendingSet is a group of pending changes associated with a particular user and workspace. Each PendingSet in the returned array may contain multiple pending changes.