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 restreindre 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 des identités dans ce format, et également noms complets (« Maggie Carrido »).
Propriété publique BatchSize Taille de lots au 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 spécifié dans la propriété d'é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 ; en fournissant une autre valeur pour cette propriété n'est pas courante, et est nécessaire uniquement lorsque vous utilisez TFS 2005 ou 2008.
Propriété publique IncludeChanges Définissez cette propriété sur 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 contiendra uniquement les métadonnées d'ensemble de modifications. Notez que même si cette propriété a la valeur true, le jeu d'objets retournés de modification relatives 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.Définissez cette valeur True pour afficher 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 en utilisant un aller-retour vers le serveur au lieu de deux.La définition de cette valeur True des augmentation du temps de calcul sur le serveur pour l'appel de QueryHistory, et la taille du jeu de résultats sur le responsable.Pour des raisons de performance, vous devez activer cet indicateur uniquement si vous prévoyez de télécharger le contenu des objets retournés de modification.
Propriété publique Item É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, c'est-à-dire $/Abc/def/*.cs.L'élément peut être un serveur ou un chemin local.
Propriété publique ItemVersion Un VersionSpec décrivant le moment auquel le chemin d'accès spécifié dans la propriété d'élément doit être résolu.Valeurs par défaut à VersionSpec.Latest ; en fournissant une autre valeur pour cette propriété n'est pas courante.
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 la valeur Int32.MaxValue.QueryHistory pages des résultats privilégient du serveur à la demande.Par conséquent, la limitation de votre propre consommation de l'IEnumerable est presque aussi efficaces d'une perspective de performance.
Propriété publique RecursionType Type de récursivité à appliquer à la propriété d'élément lorsque vous exécutez la requête historique.
Propriété publique SlotMode Si cette propriété a la valeur False, ensuite (élément, ItemVersion, DeletionId) le tuple est résolu à un ID d'élément et l'historique est effectué sur cet ID d'élément, suivant à travers le renomme.Si cette propriété est True, le tuple n'est pas résolu.Au lieu de cela, 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 « slot de l'espace de noms » particulier (mode de slot) plutôt qu'un point 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), définissez cet indicateur true. Cet indicateur en requiert un TFS 2010 ou d'un serveur de version ultérieure d'avoir.
Propriété publique VersionEnd Définissez cette propriété pour restreindre la requête historique le long de l'axe du temps.Cette propriété a comme valeur par défaut pour annuler, pour indiquer que la plage de démarrage historiques de requête avec le dernier ensemble de modifications dans le référentiel.
Propriété publique VersionStart Définissez cette propriété pour restreindre la requête historique le long de l'axe du temps.Cette propriété a comme valeur par défaut pour annuler, pour indiquer que la plage de la requête historique est complètement retourne lorsque le référentiel a été créé.

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 à exécuter d'autres opérations de nettoyage avant qu'il ne soit récupéré par une opération garbage collection. (Hérité de Object.)
Méthode publique GetHashCode Fait office de fonction de hachage par défaut. (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 du Object actuel. (Hérité de Object.)
Méthode publique ToString Retourne une chaîne qui représente l'objet actuel. (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