VersionControlServer.QueryShelvedChanges Method (Shelveset, array<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 in the specified shelveset, but download information is not included. Without download information the query 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)

Syntax

'Declaration
Public Function QueryShelvedChanges ( _
    shelveset As Shelveset, _
    itemSpecs As ItemSpec() _
) As PendingSet()
'Usage
Dim instance As VersionControlServer 
Dim shelveset As Shelveset 
Dim itemSpecs As ItemSpec()
Dim returnValue As PendingSet()

returnValue = instance.QueryShelvedChanges(shelveset, _
    itemSpecs)
public PendingSet[] QueryShelvedChanges(
    Shelveset shelveset,
    ItemSpec[] itemSpecs
)
public:
array<PendingSet^>^ QueryShelvedChanges(
    Shelveset^ shelveset, 
    array<ItemSpec^>^ itemSpecs
)
public function QueryShelvedChanges(
    shelveset : Shelveset, 
    itemSpecs : ItemSpec[]
) : PendingSet[]

Parameters

  • itemSpecs
    Type: array<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: array<Microsoft.TeamFoundation.VersionControl.Client.PendingSet[]
A PendingSet is a group of pending changes associated with a particular user and workspace. The returned array will contain at most one PendingSet; however, this set may contain multiple pending changes.

.NET Framework Security

See Also

Reference

VersionControlServer Class

VersionControlServer Members

QueryShelvedChanges Overload

Microsoft.TeamFoundation.VersionControl.Client Namespace