Share via


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

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

Parameters

  • shelvesetName
    Type: System.String

    the shelveset name (may be null)

  • shelvesetOwner
    Type: System.String

    the user name (may be null), which is the shelveset owner if the shelveset name is not null

  • includeDownloadInfo
    Type: System.Boolean

    If true, the server will include the information needed to download files. Only set this to true if you will be downloading the files by using the objects that are returned. The call will be faster and require less bandwidth when this parameter is false (default for overloads that do not specify it)

  • itemPropertyFilters
    Type: array<System.String[]

    List of property names to retrieve for the PendingChanges.

Return Value

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

.NET Framework Security

See Also

Reference

Workspace Class

QueryShelvedChanges Overload

Microsoft.TeamFoundation.VersionControl.Client Namespace