VersionControlServer.QueryHistory Method (String, VersionSpec, Int32, RecursionType, String, VersionSpec, VersionSpec, Int32, Boolean, Boolean, Boolean, Boolean)

Gets a collection of Changeset objects matching the specified items and versions.

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

Syntax

'Declaration
Public Function QueryHistory ( _
    path As String, _
    version As VersionSpec, _
    deletionId As Integer, _
    recursion As RecursionType, _
    user As String, _
    versionFrom As VersionSpec, _
    versionTo As VersionSpec, _
    maxCount As Integer, _
    includeChanges As Boolean, _
    slotMode As Boolean, _
    includeDownloadInfo As Boolean, _
    sortAscending As Boolean _
) As IEnumerable

public IEnumerable QueryHistory(
    string path,
    VersionSpec version,
    int deletionId,
    RecursionType recursion,
    string user,
    VersionSpec versionFrom,
    VersionSpec versionTo,
    int maxCount,
    bool includeChanges,
    bool slotMode,
    bool includeDownloadInfo,
    bool sortAscending
)

public:
IEnumerable^ QueryHistory(
    String^ path, 
    VersionSpec^ version, 
    int deletionId, 
    RecursionType recursion, 
    String^ user, 
    VersionSpec^ versionFrom, 
    VersionSpec^ versionTo, 
    int maxCount, 
    bool includeChanges, 
    bool slotMode, 
    bool includeDownloadInfo, 
    bool sortAscending
)

member QueryHistory : 
        path:string * 
        version:VersionSpec * 
        deletionId:int * 
        recursion:RecursionType * 
        user:string * 
        versionFrom:VersionSpec * 
        versionTo:VersionSpec * 
        maxCount:int * 
        includeChanges:bool * 
        slotMode:bool * 
        includeDownloadInfo:bool * 
        sortAscending:bool -> IEnumerable

public function QueryHistory(
    path : String, 
    version : VersionSpec, 
    deletionId : int, 
    recursion : RecursionType, 
    user : String, 
    versionFrom : VersionSpec, 
    versionTo : VersionSpec, 
    maxCount : int, 
    includeChanges : boolean, 
    slotMode : boolean, 
    includeDownloadInfo : boolean, 
    sortAscending : boolean
) : IEnumerable

Parameters

• path
  Type: System.String

  The local path to an item for which history will be queried. This parameter can include wildcards.

• version
  Type: Microsoft.TeamFoundation.VersionControl.Client.VersionSpec

  The version of the item for which history will be queried.

• deletionId
  Type: System.Int32

  The unique deletion ID for the item, if it is deleted. Otherwise, specify 0.

• recursion
  Type: Microsoft.TeamFoundation.VersionControl.Client.RecursionType

  A flag describing whether history will be recursively queried.

• user
  Type: System.String

  The user for whom history will be queried. Specify null for any user.

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

  The earliest version for which history will be queried. Specify null to begin with the first changeset.

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

  The latest version for which history will be queried. Specify null to end with the latest changeset.

• maxCount
  Type: System.Int32

  The maximum number of history entries to return. Specify MaxValue to get all changes.

• includeChanges
  Type: System.Boolean

  A flag that describes whether the individual item changes will be included with the changesets. Otherwise, only changeset metadata is included.

• slotMode
  Type: System.Boolean

  A flag that describes how history entries are searched. If 'true', the returned history entries may reflect multiple different items that have occupied the requested path in the repository. If 'false', the returned history entries will reflect the single item currently occupying the requested path.

• includeDownloadInfo
  Type: System.Boolean

  A flag that describes whether to get the information necessary to download the changesets from the server.

• sortAscending
  Type: System.Boolean

  A flag that describes whether to sort the results in ascending order. Specify false to not sort the results.

Return Value

Type: System.Collections.IEnumerable
A collection of Changeset objects matching the query.

.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

VersionControlServer Class

QueryHistory Overload

Microsoft.TeamFoundation.VersionControl.Client Namespace