Share via

Repository5.QueryPendingSets Method

  • Article

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 of 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 belonging to that workspace.

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

Syntax

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

[WebMethodAttribute]
public StreamingCollection<PendingSet> QueryPendingSets(
    string localWorkspaceName,
    string localWorkspaceOwner,
    string queryWorkspaceName,
    string ownerName,
    ItemSpec[] itemSpecs,
    bool generateDownloadUrls,
    string[] itemPropertyFilters,
    int maxClientPathLength,
    out StreamingCollection<Failure> failures
)

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

[<WebMethodAttribute>]
member QueryPendingSets : 
        localWorkspaceName:string * 
        localWorkspaceOwner:string * 
        queryWorkspaceName:string * 
        ownerName:string * 
        itemSpecs:ItemSpec[] * 
        generateDownloadUrls:bool * 
        itemPropertyFilters:string[] * 
        maxClientPathLength:int * 
        failures:StreamingCollection<Failure> byref -> StreamingCollection<PendingSet> 

public function QueryPendingSets(
    localWorkspaceName : String, 
    localWorkspaceOwner : String, 
    queryWorkspaceName : String, 
    ownerName : String, 
    itemSpecs : ItemSpec[], 
    generateDownloadUrls : boolean, 
    itemPropertyFilters : String[], 
    maxClientPathLength : int, 
    failures : StreamingCollection<Failure>
) : StreamingCollection<PendingSet>

Parameters

  • localWorkspaceName
    Type: System.String

    Name of workspace to find changes from. If null, all workspaces are chosen.

  • localWorkspaceOwner
    Type: System.String

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

  • itemPropertyFilters
    Type: array<System.String[]

    Filters for the property names to return.

  • maxClientPathLength
    Type: System.Int32

    The maximum supported path length.

Return Value

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

.NET Framework Security

See Also

Reference

Repository5 Class

Microsoft.TeamFoundation.VersionControl.Server Namespace