This documentation is archived and is not being maintained.

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

Visual Studio 2013

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)

C#
C++
F#
JScript
VB
Copy 
public:
IEnumerable^ QueryHistory(
	String^ path, 
	VersionSpec^ version, 
	int deletionId, 
	RecursionType recursion, 
	String^ user, 
	VersionSpec^ versionFrom, 
	VersionSpec^ versionTo, 
	int maxCount, 
	bool includeChanges, 
	bool slotMode
)

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 Int32.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 been at the requested path in the repository. If 'false', the returned history entries will reflect the single item currently at the requested path.

Return Value

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

Show: