Partager via


QueryHistoryParameters, classe

Représente tous les paramètres requis pour appeler la méthode de QueryHistory sur l'objet de VersionControlServer.

Hiérarchie d'héritage

System.Object
  Microsoft.TeamFoundation.VersionControl.Client.QueryHistoryParameters

Espace de noms :  Microsoft.TeamFoundation.VersionControl.Client
Assembly :  Microsoft.TeamFoundation.VersionControl.Client (dans Microsoft.TeamFoundation.VersionControl.Client.dll)

Syntaxe

'Déclaration
Public Class QueryHistoryParameters
public class QueryHistoryParameters

Le type QueryHistoryParameters expose les membres suivants.

Constructeurs

  Nom Description
Méthode protégée QueryHistoryParameters() Initialise une nouvelle instance de la classe QueryHistoryParameters.
Méthode publique QueryHistoryParameters(ItemSpec) Crée un objet de QueryHistoryParameters.
Méthode publique QueryHistoryParameters(String, RecursionType) Crée un objet de QueryHistoryParameters.

Début

Propriétés

  Nom Description
Propriété publique Author Cette propriété a la valeur par défaut null.Définissez cette propriété pour limiter la requête historique à l'ensemble des ensembles de modifications créés par une identité particulière.Pour les serveurs de TFS 2010 et versions antérieures, cette propriété doit se présenter sous la forme « DOMAINE\utilisateur ».De derniers serveur acceptent les identités dans ce format, et également noms complets (« Maggie Carrido »).
Propriété publique BatchSize La taille de lots pour le mécanisme de pagination de QueryHistory.La valeur par défaut de cette propriété est 256.
Propriété publique DeletionId Si le chemin d'accès fourni dans la propriété de l'élément est supprimé, l'ID de suppression du point particulier référencé par la propriété d'élément peut être fournie ici.Valeurs par défaut à zéro ; fournir une autre valeur pour cette propriété n'est pas commun, et est uniquement requis lorsque vous utilisez TFS 2005 ou 2008.
Propriété publique IncludeChanges Affectez à cette propriété la valeur true si vous devez pour les objets retournés d'ensemble de modifications contiennent les objets réels de modification (le manifeste de l'ensemble de modifications).Par défaut, cette propriété a la valeur false, et les objets d'ensemble de modifications retournés contiendront uniquement les métadonnées de l'ensemble de modifications. Notez que même si cette propriété a la valeur true, le jeu d'objets retournés de modification est limitée aux paires d'éléments/RecursionType utilisées pour exécuter la requête.
Propriété publique IncludeDownloadInfo Cette propriété s'applique uniquement lorsque IncludeChanges a la valeur true.Affectez à cette propriété la valeur true pour que les inclure au serveur générer des URL de téléchargement et avec les objets de modification retournés dans chaque ensemble de modifications.Cela permet au client pour télécharger le contenu du fichier associé à un objet particulier de modification à l'aide d'un aller-retour vers le serveur au lieu de deux.Définissant cette valeur true à la propriété d'une augmentation du temps de calcul sur le serveur pour l'appel de QueryHistory, et également la taille du jeu de résultats sur le thread.Pour des raisons de performances, vous devez activer cette balise uniquement si vous avez l'intention de télécharger le contenu des objets retournés de modification.
Propriété publique Item L'élément dont l'historique doit être récupéré.La dernière partie du chemin d'accès peut inclure ?* et les caractères génériques, qui est $/Abc/def/*.cs.L'élément peut être un serveur ou un chemin d'accès local.
Propriété publique ItemVersion Un VersionSpec décrivant le moment auquel le chemin d'accès fourni dans la propriété de l'élément doit être résolu.Valeurs par défaut à VersionSpec.Latest ; fournir une autre valeur pour cette propriété n'est pas commun.
Propriété publique MaxResults Définissez cette propriété pour limiter le nombre de résultats retournés par l'appel de QueryHistory.Par défaut, cette propriété a Int32.MaxValue.QueryHistory pages des résultats privilégient du serveur à la demande.Par conséquent, limiter votre propre utilisation de l'IEnumerable est presque comme efficace d'un point de vue de performances.
Propriété publique RecursionType Le type de récursivité à appliquer à la propriété d'un élément lorsque vous exécutez la requête historique.
Propriété publique SlotMode Si cette propriété a la valeur false, puis (élément, ItemVersion, DeletionId) du tuple est résolu à un ID d'élément et l'historique est effectué sur cet ID d'élément, incliné suivant à renomme.Si cette propriété est true, le tuple n'est pas résolu.À la place, tous les ensembles de modifications qui ont un élément avec l'élément de nom (ou au-dessous, si la requête est récursive), sont retournés.Autrement dit, la requête est activée sur un « emplacement de l'espace de noms » particulier (mode de emplacement) au lieu d'un élément particulier. Cette propriété a par défaut la valeur true.
Propriété publique SortAscending Par défaut, les résultats d'un appel de QueryHistory sont de VersionEnd à VersionStart (ordre inverse). Si vous souhaitez les résultats à retourner dans l'ordre croissant à la place (VersionStart à VersionEnd), affectez à cet indicateur la valeur true. Cette balise en requiert un TFS 2010 ou d'un serveur de version ultérieure à exécuter.
Propriété publique VersionEnd Définissez cette propriété pour limiter la requête historique sur l'axe de temps.Cette propriété a la valeur par défaut pour annuler, pour indiquer que la plage de la requête historique commence par le dernier ensemble de modifications dans la base de données de référentiel.
Propriété publique VersionStart Définissez cette propriété pour limiter la requête historique sur l'axe de temps.Cette propriété a la valeur par défaut pour annuler, pour indiquer que la plage de la requête historique devient totalement nouveau la valeur lorsque le référentiel a été créée.

Début

Méthodes

  Nom Description
Méthode publique Equals Détermine si l'objet spécifié est identique à l'objet actuel. (Hérité de Object.)
Méthode protégée Finalize Autorise un objet à tenter de libérer des ressources et d'exécuter d'autres opérations de nettoyage avant qu'il ne soit récupéré par l'opération garbage collection. (Hérité de Object.)
Méthode publique GetHashCode Sert de fonction de hachage pour un type particulier. (Hérité de Object.)
Méthode publique GetType Obtient le Type de l'instance actuelle. (Hérité de Object.)
Méthode protégée MemberwiseClone Crée une copie superficielle de l'objet Object actuel. (Hérité de Object.)
Méthode publique ToString Retourne une chaîne qui représente l'objet actif. (Hérité de Object.)

Début

Sécurité des threads

Tous les membres static (Shared en Visual Basic) publics de ce type sont thread-safe. Il n'est pas garanti que les membres d'instance soient thread-safe.

Voir aussi

Référence

Microsoft.TeamFoundation.VersionControl.Client, espace de noms