VersionControlServer.QueryShelvedChanges Method (String, String, array<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)
Syntax
'Declaration
Public Function QueryShelvedChanges ( _
shelvesetName As String, _
shelvesetOwner As String, _
itemSpecs As ItemSpec(), _
includeDownloadInfo As Boolean _
) As PendingSet()
'Usage
Dim instance As VersionControlServer
Dim shelvesetName As String
Dim shelvesetOwner As String
Dim itemSpecs As ItemSpec()
Dim includeDownloadInfo As Boolean
Dim returnValue As PendingSet()
returnValue = instance.QueryShelvedChanges(shelvesetName, _
shelvesetOwner, itemSpecs, includeDownloadInfo)
public PendingSet[] QueryShelvedChanges(
string shelvesetName,
string shelvesetOwner,
ItemSpec[] itemSpecs,
bool includeDownloadInfo
)
public:
array<PendingSet^>^ QueryShelvedChanges(
String^ shelvesetName,
String^ shelvesetOwner,
array<ItemSpec^>^ itemSpecs,
bool includeDownloadInfo
)
public function QueryShelvedChanges(
shelvesetName : String,
shelvesetOwner : String,
itemSpecs : ItemSpec[],
includeDownloadInfo : boolean
) : 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 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.BooleanIf 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: 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.
Remarks
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.
.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.