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

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
Public Function QueryPendingSets ( _
    requestContext As TeamFoundationRequestContext, _
    localWorkspaceName As String, _
    localWorkspaceOwner As String, _
    queryWorkspaceName As String, _
    ownerName As String, _
    itemSpecs As ItemSpec(), _
    generateDownloadUrls As Boolean, _
    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,
    bool maskLocalWorkspaces,
    string[] itemPropertyFilters,
    bool includePendingChangeSignature
)

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

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

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

Parameters

• requestContext
  Type: Microsoft.TeamFoundation.Framework.Server.TeamFoundationRequestContext

  The request context.

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

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

  The items.

• generateDownloadUrls
  Type: System.Boolean

  If true, the server will include the information that is required to download files. Only set this to true if you will be downloading the files that use 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).

• maskLocalWorkspaces
  Type: System.Boolean

• itemPropertyFilters
  Type: array<System.String[]

• includePendingChangeSignature
  Type: System.Boolean

Return Value

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

.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

TeamFoundationVersionControlService Class

QueryPendingSets Overload

Microsoft.TeamFoundation.VersionControl.Server Namespace