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

Gets the shelved changes for the specified query.

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.

  • includeDownloadInfo
    Type: System.Boolean

    True to include the information that is required to download files. False not to include.

Return Value

Type: array<Microsoft.TeamFoundation.VersionControl.Client.PendingSet[]
An array of pending sets with the pending changes for the shelved changes.

Remarks

Set includeDownloadInfo to true only if you will use the information that is returned to download the files. The call will be faster and require less bandwidth when this parameter is false (default for overloads that do not specify it)

.NET Framework Security

See Also

Reference

Workspace Class

QueryShelvedChanges Overload

Microsoft.TeamFoundation.VersionControl.Client Namespace