Repository4.QueryShelvedChanges Method

Returns a list of pending changes matching specified criteria.

If workspaceName is not null, ownerName must also be specified.

Children are returned according to the recursive option. If RecursionType.None is specified, only the serverItem is returned. If RecursionType.OneLevel is specified and serverItem represents a folder, that folder and its direct children are returned. If RecursionType.Full is specified and serverItem is a folder, all its descendants are returned.

This function returns an array of PendingSet objects, each of which represents a workspace. Within each PendingSet object is an array of PendingChanges that represent the changes that belong to that workspace.

Namespace:  Microsoft.TeamFoundation.VersionControl.Server
Assembly:  Microsoft.TeamFoundation.VersionControl.Server (in Microsoft.TeamFoundation.VersionControl.Server.dll)

Syntax

'Declaration
<WebMethodAttribute> _
Public Function QueryShelvedChanges ( _
    localWorkspaceName As String, _
    localWorkspaceOwner As String, _
    shelvesetName As String, _
    ownerName As String, _
    itemSpecs As ItemSpec(), _
    generateDownloadUrls As Boolean, _
    itemPropertyFilters As String(), _
    <OutAttribute> ByRef failures As StreamingCollection(Of Failure) _
) As StreamingCollection(Of PendingSet)

[WebMethodAttribute]
public StreamingCollection<PendingSet> QueryShelvedChanges(
    string localWorkspaceName,
    string localWorkspaceOwner,
    string shelvesetName,
    string ownerName,
    ItemSpec[] itemSpecs,
    bool generateDownloadUrls,
    string[] itemPropertyFilters,
    out StreamingCollection<Failure> failures
)

[WebMethodAttribute]
public:
StreamingCollection<PendingSet^>^ QueryShelvedChanges(
    String^ localWorkspaceName, 
    String^ localWorkspaceOwner, 
    String^ shelvesetName, 
    String^ ownerName, 
    array<ItemSpec^>^ itemSpecs, 
    bool generateDownloadUrls, 
    array<String^>^ itemPropertyFilters, 
    [OutAttribute] StreamingCollection<Failure^>^% failures
)

[<WebMethodAttribute>]
member QueryShelvedChanges : 
        localWorkspaceName:string * 
        localWorkspaceOwner:string * 
        shelvesetName:string * 
        ownerName:string * 
        itemSpecs:ItemSpec[] * 
        generateDownloadUrls:bool * 
        itemPropertyFilters:string[] * 
        failures:StreamingCollection<Failure> byref -> StreamingCollection<PendingSet> 

public function QueryShelvedChanges(
    localWorkspaceName : String, 
    localWorkspaceOwner : String, 
    shelvesetName : String, 
    ownerName : String, 
    itemSpecs : ItemSpec[], 
    generateDownloadUrls : boolean, 
    itemPropertyFilters : String[], 
    failures : StreamingCollection<Failure>
) : StreamingCollection<PendingSet>

Parameters

• localWorkspaceName
  Type: System.String

• localWorkspaceOwner
  Type: System.String

• shelvesetName
  Type: System.String

• ownerName
  Type: System.String

  Owner of workspace(s) to find changes from. If null, all users are returned.

• itemSpecs
  Type: array<Microsoft.TeamFoundation.VersionControl.Server.ItemSpec[]

• generateDownloadUrls
  Type: System.Boolean

• itemPropertyFilters
  Type: array<System.String[]

• failures
  Type: Microsoft.TeamFoundation.Framework.Server.StreamingCollection<Failure>%

Return Value

Type: Microsoft.TeamFoundation.Framework.Server.StreamingCollection<PendingSet>
Array of PendingSet objects that contain PendingChanges.

.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.

See Also

Reference

Repository4 Class

Microsoft.TeamFoundation.VersionControl.Server Namespace