VersionControlServer.QueryShelvedChanges Method (String, String, 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 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)
Syntax
'Declaration
Public Function QueryShelvedChanges ( _
shelvesetName As String, _
shelvesetOwner As String, _
itemSpecs As ItemSpec() _
) As PendingSet()
'Usage
Dim instance As VersionControlServer
Dim shelvesetName As String
Dim shelvesetOwner As String
Dim itemSpecs As ItemSpec()
Dim returnValue As PendingSet()
returnValue = instance.QueryShelvedChanges(shelvesetName, _
shelvesetOwner, itemSpecs)
public PendingSet[] QueryShelvedChanges(
string shelvesetName,
string shelvesetOwner,
ItemSpec[] itemSpecs
)
public:
array<PendingSet^>^ QueryShelvedChanges(
String^ shelvesetName,
String^ shelvesetOwner,
array<ItemSpec^>^ itemSpecs
)
public function QueryShelvedChanges(
shelvesetName : String,
shelvesetOwner : String,
itemSpecs : ItemSpec[]
) : PendingSet[]
Parameters
shelvesetName
Type: System.StringThe shelveset name (may be null).
shelvesetOwner
Type: System.StringThe user name (may be null), which is the shelveset owner if the shelveset name is not null.
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. Each PendingSet in the returned array may contain multiple pending changes.
.NET Framework Security
- Full trust for the immediate caller. This member cannot be used by partially trusted code. For more information, see Using Libraries from Partially Trusted Code.