VersionControlServer.QueryShelvedChanges Method (String, String, array<ItemSpec , Boolean)

Gets the shelved changes in the specified Shelveset.

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()
public PendingSet[] QueryShelvedChanges(
    string shelvesetName,
    string shelvesetOwner,
    ItemSpec[] itemSpecs,
    bool includeDownloadInfo
)
public:
array<PendingSet^>^ QueryShelvedChanges(
    String^ shelvesetName, 
    String^ shelvesetOwner, 
    array<ItemSpec^>^ itemSpecs, 
    bool includeDownloadInfo
)
member QueryShelvedChanges : 
        shelvesetName:string * 
        shelvesetOwner:string * 
        itemSpecs:ItemSpec[] * 
        includeDownloadInfo:bool -> PendingSet[] 
public function QueryShelvedChanges(
    shelvesetName : String, 
    shelvesetOwner : String, 
    itemSpecs : ItemSpec[], 
    includeDownloadInfo : boolean
) : PendingSet[]

Parameters

  • shelvesetName
    Type: System.String

    The shelveset name. May be null.

  • shelvesetOwner
    Type: System.String

    The shelveset owner. May be null.

  • includeDownloadInfo
    Type: System.Boolean

    True to get the information needed to download files. Specify false to save bandwidth if not necessary.

Return Value

Type: array<Microsoft.TeamFoundation.VersionControl.Client.PendingSet[]
An array of PendingSet objects with the pending changes for the specified Shelveset.

Remarks

Only set includeDownloadInfo to true if you are going to be downloading the files using the objects that are returned. This method call will be faster and require less bandwidth when includeDownloadInfo is false (default for overloads that do not specify it).

.NET Framework Security

See Also

Reference

VersionControlServer Class

QueryShelvedChanges Overload

Microsoft.TeamFoundation.VersionControl.Client Namespace