This documentation is archived and is not being maintained.

QueryHistoryParameters Class

Represents all the parameters that are required to call the QueryHistory method on the VersionControlServer object.


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

public class QueryHistoryParameters

The QueryHistoryParameters type exposes the following members.

Protected methodQueryHistoryParameters()Initializes a new instance of the QueryHistoryParameters class.
Public methodQueryHistoryParameters(ItemSpec)Creates a new QueryHistoryParameters object.
Public methodQueryHistoryParameters(String, RecursionType)Creates a new QueryHistoryParameters object.

Public propertyAuthorThis property defaults to null. Set this property to restrict the history query to the set of changesets authored by a particular identity. For TFS 2010 servers and earlier, this property must be in the form "DOMAIN\user". Later servers accept identities in this format, and also display names ("Maggie Carrido").
Public propertyBatchSizeThe batch size for the QueryHistory paging mechanism. The default value for this property is 256.
Public propertyDeletionIdIf the path provided in the Item property is deleted, the deletion ID of the particular item referred to by the Item property may be provided here. Defaults to zero; supplying another value for this property is not common, and is only necessary when you use TFS 2005 or 2008.
Public propertyIncludeChangesSet this property to true if you need for the returned Changeset objects to contain actual Change objects (the manifest of the changeset). By default, this property is false, and the Changeset objects returned will contain only the changeset metadata. Note that even when this property is set to true, the set of returned Change objects is scoped to the Item/RecursionType pair used to perform the query.
Public propertyIncludeDownloadInfoThis property applies only when IncludeChanges is set to true. Set this property to true to have the server generate download URLs and include them with the Change objects returned in each Changeset. This allows the client to download the file content associated with a particular Change object by using one round-trip to the server instead of two. Setting this property to true increases the computation time on the server for the QueryHistory call, and also the size of the result set on the wire. For performance reasons, you should enable this flag only if you intend to download the content the returned Change objects.
Public propertyItemThe item whose history is to be retrieved. The last path part may include the ? and * wildcard characters, that is $/Abc/def/*.cs. The item may be a server or a local path.
Public propertyItemVersionA VersionSpec describing the point in time at which the path provided in the Item property should be resolved. Defaults to VersionSpec.Latest; supplying another value for this property is not common.
Public propertyMaxResultsSet this property to limit the number of results returned by the QueryHistory call. By default, this property is set to Int32.MaxValue. QueryHistory pages results back from the server on demand. Therefore, limiting your own consumption of the IEnumerable is almost as effective from a performance perspective.
Public propertyRecursionTypeThe recursion type to apply to the Item property when you perform the history query.
Public propertySlotModeIf this property is false, then the (Item, ItemVersion, DeletionId) tuple is resolved to an item ID and the history is performed on that item ID, tracking across renames. If this property is true, then the tuple is not resolved. Instead, all changesets which have an item with the name Item (or underneath it, if the query is recursive), are returned. That is, the query is on a particular "namespace slot" (slot mode) instead of on a particular item. This property defaults to true.
Public propertySortAscendingBy default, the results from a QueryHistory call are from VersionEnd to VersionStart (reverse order). If you want the results to be returned in ascending order instead (from VersionStart to VersionEnd), set this flag to true. This flag requires a TFS 2010 or a later version server to have any effect.
Public propertyVersionEndSet this property to restrict the history query along the time axis. This property defaults to null, to indicate that the range of the history query starts with the latest changeset in the repository.
Public propertyVersionStartSet this property to restrict the history query along the time axis. This property defaults to null, to indicate that the range of the history query goes all the way back to when the repository was created.

Public methodEqualsDetermines whether the specified object is equal to the current object. (Inherited from Object.)
Protected methodFinalizeAllows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object.)
Public methodGetHashCodeServes as the default hash function. (Inherited from Object.)
Public methodGetTypeGets the Type of the current instance. (Inherited from Object.)
Protected methodMemberwiseCloneCreates a shallow copy of the current Object. (Inherited from Object.)
Public methodToStringReturns a string that represents the current object. (Inherited from Object.)

Any public static (Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.