TeamFoundationVersionControlService.QueryHistory Method

Returns changeset information about an item and its children. The maxCount newest changesets will be returned that involve the specified item and are in the range of versionFrom->versionTo.

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

Syntax

'Declaration
Public Function QueryHistory ( _
    requestContext As TeamFoundationRequestContext, _
    workspaceName As String, _
    workspaceOwner As String, _
    itemSpec As ItemSpec, _
    versionItem As VersionSpec, _
    user As String, _
    versionFrom As VersionSpec, _
    versionTo As VersionSpec, _
    maxCount As Integer, _
    includeFiles As Boolean, _
    generateDownloadUrls As Boolean, _
    slotMode As Boolean, _
    sortAscending As Boolean _
) As TeamFoundationDataReader

public TeamFoundationDataReader QueryHistory(
    TeamFoundationRequestContext requestContext,
    string workspaceName,
    string workspaceOwner,
    ItemSpec itemSpec,
    VersionSpec versionItem,
    string user,
    VersionSpec versionFrom,
    VersionSpec versionTo,
    int maxCount,
    bool includeFiles,
    bool generateDownloadUrls,
    bool slotMode,
    bool sortAscending
)

public:
TeamFoundationDataReader^ QueryHistory(
    TeamFoundationRequestContext^ requestContext, 
    String^ workspaceName, 
    String^ workspaceOwner, 
    ItemSpec^ itemSpec, 
    VersionSpec^ versionItem, 
    String^ user, 
    VersionSpec^ versionFrom, 
    VersionSpec^ versionTo, 
    int maxCount, 
    bool includeFiles, 
    bool generateDownloadUrls, 
    bool slotMode, 
    bool sortAscending
)

member QueryHistory : 
        requestContext:TeamFoundationRequestContext * 
        workspaceName:string * 
        workspaceOwner:string * 
        itemSpec:ItemSpec * 
        versionItem:VersionSpec * 
        user:string * 
        versionFrom:VersionSpec * 
        versionTo:VersionSpec * 
        maxCount:int * 
        includeFiles:bool * 
        generateDownloadUrls:bool * 
        slotMode:bool * 
        sortAscending:bool -> TeamFoundationDataReader

public function QueryHistory(
    requestContext : TeamFoundationRequestContext, 
    workspaceName : String, 
    workspaceOwner : String, 
    itemSpec : ItemSpec, 
    versionItem : VersionSpec, 
    user : String, 
    versionFrom : VersionSpec, 
    versionTo : VersionSpec, 
    maxCount : int, 
    includeFiles : boolean, 
    generateDownloadUrls : boolean, 
    slotMode : boolean, 
    sortAscending : boolean
) : TeamFoundationDataReader

Parameters

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

  The request context.

• workspaceName
  Type: System.String

  Workspace name (if a local path is supplied).

• workspaceOwner
  Type: System.String

  Workspace owner (if a local path is supplied).

• itemSpec
  Type: Microsoft.TeamFoundation.VersionControl.Server.ItemSpec

  Root item, deletionId and recursion flag. Accepts server or local paths.

• versionItem
  Type: Microsoft.TeamFoundation.VersionControl.Server.VersionSpec

  Version spec used to qualify the itemSpec.

• user
  Type: System.String

  User to display changesets created by. Null == any user.

• versionFrom
  Type: Microsoft.TeamFoundation.VersionControl.Server.VersionSpec

  Oldest changeset to return. Null == epoch.

• versionTo
  Type: Microsoft.TeamFoundation.VersionControl.Server.VersionSpec

  Newest changeset to return. Null == now.

• maxCount
  Type: System.Int32

  Maximum number of changesets to return.

• includeFiles
  Type: System.Boolean

  Whether files (Change's) should be included in the data.

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

• slotMode
  Type: System.Boolean

  Specifies slot or item mode behavior.

• sortAscending
  Type: System.Boolean

  Instructs the server to return the top maxCount results in ascending order.

Return Value

Type: Microsoft.TeamFoundation.Framework.Server.TeamFoundationDataReader
TeamFoundationDataReader with results in the following order: Changeset[] - Array of Changesets, newest first.

.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