TeamFoundationVersionControlService.QueryPendingSets Method (TeamFoundationRequestContext, String, String, String, String, array<ItemSpec[], Boolean, PathLength, Boolean, array<String , Boolean)

  • 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
Public Function QueryPendingSets ( _
    requestContext As TeamFoundationRequestContext, _
    localWorkspaceName As String, _
    localWorkspaceOwner As String, _
    queryWorkspaceName As String, _
    ownerName As String, _
    itemSpecs As ItemSpec(), _
    generateDownloadUrls As Boolean, _
    maxClientPathLength As PathLength, _
    maskLocalWorkspaces As Boolean, _
    itemPropertyFilters As String(), _
    includePendingChangeSignature As Boolean _
) As TeamFoundationDataReader

public TeamFoundationDataReader QueryPendingSets(
    TeamFoundationRequestContext requestContext,
    string localWorkspaceName,
    string localWorkspaceOwner,
    string queryWorkspaceName,
    string ownerName,
    ItemSpec[] itemSpecs,
    bool generateDownloadUrls,
    PathLength maxClientPathLength,
    bool maskLocalWorkspaces,
    string[] itemPropertyFilters,
    bool includePendingChangeSignature
)

public:
TeamFoundationDataReader^ QueryPendingSets(
    TeamFoundationRequestContext^ requestContext, 
    String^ localWorkspaceName, 
    String^ localWorkspaceOwner, 
    String^ queryWorkspaceName, 
    String^ ownerName, 
    array<ItemSpec^>^ itemSpecs, 
    bool generateDownloadUrls, 
    PathLength maxClientPathLength, 
    bool maskLocalWorkspaces, 
    array<String^>^ itemPropertyFilters, 
    bool includePendingChangeSignature
)

member QueryPendingSets : 
        requestContext:TeamFoundationRequestContext * 
        localWorkspaceName:string * 
        localWorkspaceOwner:string * 
        queryWorkspaceName:string * 
        ownerName:string * 
        itemSpecs:ItemSpec[] * 
        generateDownloadUrls:bool * 
        maxClientPathLength:PathLength * 
        maskLocalWorkspaces:bool * 
        itemPropertyFilters:string[] * 
        includePendingChangeSignature:bool -> TeamFoundationDataReader

public function QueryPendingSets(
    requestContext : TeamFoundationRequestContext, 
    localWorkspaceName : String, 
    localWorkspaceOwner : String, 
    queryWorkspaceName : String, 
    ownerName : String, 
    itemSpecs : ItemSpec[], 
    generateDownloadUrls : boolean, 
    maxClientPathLength : PathLength, 
    maskLocalWorkspaces : boolean, 
    itemPropertyFilters : String[], 
    includePendingChangeSignature : boolean
) : TeamFoundationDataReader

Parameters

  • localWorkspaceName
    Type: System.String

    The local workspace name, if itemSpecs contain local paths.

  • localWorkspaceOwner
    Type: System.String

    The local workspace owner, if local workspace name is specified.

  • queryWorkspaceName
    Type: System.String

    the workspace name (may be null.)

  • ownerName
    Type: System.String

    the owner name (may be null), which is the workspace owner if the workspace name is not null.

  • generateDownloadUrls
    Type: System.Boolean

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

Return Value

Type: Microsoft.TeamFoundation.Framework.Server.TeamFoundationDataReader
TeamFoundationDataReader with results in the following order: PendingSet[] - Array of PendingSet objects containing PendingChange Failure[] - List of failures encountered while querying pending sets.

.NET Framework Security

See Also

Reference

TeamFoundationVersionControlService Class

QueryPendingSets Overload

Microsoft.TeamFoundation.VersionControl.Server Namespace