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

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 QueryShelvedChanges ( _
    requestContext As TeamFoundationRequestContext, _
    localWorkspaceName As String, _
    localWorkspaceOwner As String, _
    shelvesetName As String, _
    ownerName As String, _
    itemSpecs As ItemSpec(), _
    generateDownloadUrls As Boolean, _
    itemPropertyFilters As String() _
) As TeamFoundationDataReader

public TeamFoundationDataReader QueryShelvedChanges(
    TeamFoundationRequestContext requestContext,
    string localWorkspaceName,
    string localWorkspaceOwner,
    string shelvesetName,
    string ownerName,
    ItemSpec[] itemSpecs,
    bool generateDownloadUrls,
    string[] itemPropertyFilters
)

public:
TeamFoundationDataReader^ QueryShelvedChanges(
    TeamFoundationRequestContext^ requestContext, 
    String^ localWorkspaceName, 
    String^ localWorkspaceOwner, 
    String^ shelvesetName, 
    String^ ownerName, 
    array<ItemSpec^>^ itemSpecs, 
    bool generateDownloadUrls, 
    array<String^>^ itemPropertyFilters
)

member QueryShelvedChanges : 
        requestContext:TeamFoundationRequestContext * 
        localWorkspaceName:string * 
        localWorkspaceOwner:string * 
        shelvesetName:string * 
        ownerName:string * 
        itemSpecs:ItemSpec[] * 
        generateDownloadUrls:bool * 
        itemPropertyFilters:string[] -> TeamFoundationDataReader

public function QueryShelvedChanges(
    requestContext : TeamFoundationRequestContext, 
    localWorkspaceName : String, 
    localWorkspaceOwner : String, 
    shelvesetName : String, 
    ownerName : String, 
    itemSpecs : ItemSpec[], 
    generateDownloadUrls : boolean, 
    itemPropertyFilters : String[]
) : TeamFoundationDataReader

Parameters

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

  The request context.

• localWorkspaceName
  Type: System.String

  The name of the local workspace.

• localWorkspaceOwner
  Type: System.String

  The owner of the local workspace.

• shelvesetName
  Type: System.String

  The name of the shelveset to query changes from.

• 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[]

  Items to find or null for all 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).

• itemPropertyFilters
  Type: array<System.String[]

Return Value

Type: Microsoft.TeamFoundation.Framework.Server.TeamFoundationDataReader
TeamFoundationDataReader with results in the following order: PendingSet[] - Array of PendingSet objects that contain PendingChanges. Failure[] - List of errors which occurred when trying to query changes.

.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

QueryShelvedChanges Overload

Microsoft.TeamFoundation.VersionControl.Server Namespace