Was this page helpful?
Your feedback about this content is important. Let us know what you think.
Additional feedback?
1500 characters remaining
Export (0) Print
Expand All
Important This document may not represent best practices for current development, links to downloads and other resources may no longer be valid. Current recommended version can be found here.

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

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.

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,
	bool includeDownloadInfo
)

Parameters

shelvesetName
Type: System.String

The shelveset name (may be null).

shelvesetOwner
Type: System.String

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

itemSpecs
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 RecurstionType so that it may indicate one item, all the items in a folder, or all the items in a tree. Wildcards are also supported.

includeDownloadInfo
Type: System.Boolean

If you set includeDownloadInfo to true, the PendingChange objects in the returned PendingSet will contain information required to download a file. This makes the initial query slower, thereforeso should only be used if you want to download the file using the returned object.

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.

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.

Community Additions

ADD
Show:
© 2015 Microsoft