TeamFoundationVersionControlService.QueryPendingChangesForWorkspace 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
Public Function QueryPendingChangesForWorkspace ( _
    requestContext As TeamFoundationRequestContext, _
    workspaceName As String, _
    workspaceOwner As String, _
    itemSpecs As ItemSpec(), _
    generateDownloadUrls As Boolean, _
    pageSize As Integer, _
    lastChange As String, _
    includeMergeInfo As Boolean, _
    maskLocalWorkspaces As Boolean, _
    itemPropertyFilters As String() _
) As TeamFoundationDataReader

public TeamFoundationDataReader QueryPendingChangesForWorkspace(
    TeamFoundationRequestContext requestContext,
    string workspaceName,
    string workspaceOwner,
    ItemSpec[] itemSpecs,
    bool generateDownloadUrls,
    int pageSize,
    string lastChange,
    bool includeMergeInfo,
    bool maskLocalWorkspaces,
    string[] itemPropertyFilters
)

public:
TeamFoundationDataReader^ QueryPendingChangesForWorkspace(
    TeamFoundationRequestContext^ requestContext, 
    String^ workspaceName, 
    String^ workspaceOwner, 
    array<ItemSpec^>^ itemSpecs, 
    bool generateDownloadUrls, 
    int pageSize, 
    String^ lastChange, 
    bool includeMergeInfo, 
    bool maskLocalWorkspaces, 
    array<String^>^ itemPropertyFilters
)

member QueryPendingChangesForWorkspace : 
        requestContext:TeamFoundationRequestContext * 
        workspaceName:string * 
        workspaceOwner:string * 
        itemSpecs:ItemSpec[] * 
        generateDownloadUrls:bool * 
        pageSize:int * 
        lastChange:string * 
        includeMergeInfo:bool * 
        maskLocalWorkspaces:bool * 
        itemPropertyFilters:string[] -> TeamFoundationDataReader

public function QueryPendingChangesForWorkspace(
    requestContext : TeamFoundationRequestContext, 
    workspaceName : String, 
    workspaceOwner : String, 
    itemSpecs : ItemSpec[], 
    generateDownloadUrls : boolean, 
    pageSize : int, 
    lastChange : String, 
    includeMergeInfo : boolean, 
    maskLocalWorkspaces : boolean, 
    itemPropertyFilters : String[]
) : TeamFoundationDataReader

Parameters

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

  The request context.

• workspaceName
  Type: System.String

  The workspace name.

• workspaceOwner
  Type: System.String

  The workspace owner name.

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

  Specs for items to obtain pending changes.

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

• pageSize
  Type: System.Int32

  The maximum number of pending changes to return in this call.

• lastChange
  Type: System.String

  Specifies the last change received in a previous page. Pending changes returned in this call will be those that come strictly after this item.

• includeMergeInfo
  Type: System.Boolean

  Whether to include source merge information.

• maskLocalWorkspaces
  Type: System.Boolean

• itemPropertyFilters
  Type: array<System.String[]

Return Value

Type: Microsoft.TeamFoundation.Framework.Server.TeamFoundationDataReader
TeamFoundationDataReader with results in the following order: PendingChange[] - Array of PendingChange objects. 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

Microsoft.TeamFoundation.VersionControl.Server Namespace