Les Services associés et les Interfaces (VSPackage de contrôle de code Source)Related Services and Interfaces (Source Control VSPackage)

Cette section répertorie toutes les interfaces liées au VSPackage dans contrôle de la source de la Kit de développement logiciel Visual StudioVisual Studio SDK.This section lists all the source control VSPackage-related interfaces in the Kit de développement logiciel Visual StudioVisual Studio SDK. Le contrôle de code source VSPackage implémente certaines de ces interfaces et d’autres utilise pour accomplir les tâches de contrôle de code source.The source control VSPackage implements some of these interfaces and uses others to accomplish source control tasks.

Interfaces implémentées par et pour les VSPackages de contrôle de code SourceInterfaces Implemented by and for Source Control VSPackages

Les interfaces suivantes sont décrites dans le Kit de développement logiciel Visual StudioVisual Studio SDK, et le contrôle de code source VSPackage implémente un sous-ensemble d'entre elles, en fonction de son jeu de fonctionnalités de votre choix.The following interfaces are described in the Kit de développement logiciel Visual StudioVisual Studio SDK, and the source control VSPackage implements a subset of them depending on its desired feature set. Certaines interfaces sont marqués comme obligatoire et doit être implémentée par chaque contrôle de code source VSPackage.Some interfaces are marked as required and must be implemented by every source control VSPackage.

Pour ces interfaces un package n’implémente pas, Visual StudioVisual Studio fournit une implémentation par défaut.For those interfaces that a package does not implement, Visual StudioVisual Studio provides a default implementation. Notez que l’implémentation par défaut est conçue pour le cas lorsque aucun VSPackage n’est enregistré et aucun projet n’est contrôlé.Note that the default implementation is designed for the case when no VSPackage is registered and no project is controlled. Un contrôle de source correctement écrites VSPackage implémente les interfaces nécessaires, plutôt que de laisser à l’implémentation par défaut de ces interfaces.A properly written source control VSPackage implements all necessary interfaces rather than leaving it to the default implementation of those interfaces.

Un VSPackage de contrôle de code source doit implémenter un service privé qui encapsule tout ou partie des interfaces suivantes.A source control VSPackage must implement a private service that encapsulates some or all of the following interfaces.

Les interfaces sont :Interfaces are:

  • Requis : L’entité appropriée (projet de contrôle de code source VSPackage, Stub du contrôle Source) doit implémenter l’interface.Required: The appropriate entity (source control VSPackage, Source Control Stub, project) must implement the interface.

  • Recommandé : L’entité doit implémenter cette interface. dans le cas contraire, les fonctionnalités de contrôle de code source peuvent être limitée.Recommended: The entity should implement this interface; otherwise, source control functionality may be limited.

  • Facultatif : l’entité peut implémenter cette interface pour fournir un ensemble de fonctionnalités plus riche.Optional: the entity can implement this interface to provide a richer feature set.

InterfaceInterface ObjectifPurpose Implémenté parImplemented by Mettre en œuvre ?Implement?
IVsQueryEditQuerySave2 Éditeurs d’appeler cette interface avant de modifier ou de l’enregistrement d’un fichier.Editors call this interface before modifying or saving a file. Le contrôle de code source VSPackage peut extraire le fichier ou refuser l’opération si l’extraction échoue.The source control VSPackage can check out the file or deny the operation if the checkout fails. Contrôle de code source VSPackageSource control VSPackage RecommandéRecommended
IVsSccManager2 Cette interface fournit des fonctionnalités de contrôle de source de base pour les projets, comme l’inscription et la désinscription des projets avec contrôle de code source et la prise en charge pour les glyphes de contrôle de source de base.This interface provides basic source control functionality for projects, such as registering and unregistering projects with source control and providing support for basic source control glyphs. Contrôle de code source VSPackageSource control VSPackage ObligatoireRequired
IVsSccProject2 Cette interface est obtenue à partir de la IVsHierarchy à l’aide de la QueryInterface (fonction), ou simplement effectuer un cast de l’objet implémentant IVsHierarchy à IVsSccProject2.This interface is obtained from the IVsHierarchy using the QueryInterface function, or by simply casting the object implementing IVsHierarchy to IVsSccProject2. Il est utilisé pour obtenir les fichiers sous contrôle de code source dans un projet ou pour informer le projet de l’état actuel du contrôle source ou l’emplacement.It is used for getting the files under source control in a project or for informing the project of the current source control status or location. ProjetProject ObligatoireRequired
IVsSccProvider Le module d’intégration utilise cette interface pour définir le VSPackage actif actuels.The integration module uses this interface to set the current active VSPackage. Contrôle de code source VSPackageSource control VSPackage ObligatoireRequired
IVsTrackProjectDocuments2 Cette interface est basée sur un modèle d’abonnement.This interface is based on a subscription model. Un VSPackage peut signaler qu’il souhaite recevoir des événements de document et d’être avertie par le shell sur les événements qui sont sur le point de se produire.Any VSPackage can signal that it wants to receive document events and be advised by the shell on events that are about to happen. Il est implémenté et géré par Visual StudioVisual Studio, qui à son tour transmet les événements implémentant le IVsTrackProjectDocumentsEvents2 pour le VSPackage.It is implemented and handled by Visual StudioVisual Studio, which in turn passes events implementing the IVsTrackProjectDocumentsEvents2 to the VSPackage. Stub de contrôle de code sourceSource Control Stub ObligatoireRequired
IVsTrackProjectDocuments3 Cette interface fournit le traitement par lots, les opérations de synchronisée en lecture/écriture et avancée OnQueryAddFiles (méthode).This interface provides batch processing, synchronized read/write operations, and an advanced OnQueryAddFiles method. Stub de contrôle de code sourceSource Control Stub ObligatoireRequired
IVsTrackProjectDocumentsEvents2 L’Explorateur de solutions et projets appellent cette interface lorsque de nouveaux fichiers sont ajoutés aux projets, ou lorsque les fichiers et dossiers sont renommés ou supprimés à partir de projets.Solution Explorer and projects call this interface when new files are added to the projects, or when files and folders are renamed or deleted from projects. Le contrôle de code source VSPackage peut extraire le fichier projet ou annuler l’opération.The source control VSPackage can check out the project file or cancel the operation. Contrôle de code source VSPackageSource control VSPackage RecommandéRecommended
IVsTrackProjectDocumentsEvents3 L’Explorateur de solutions et projets appellent cette interface en réponse aux appels effectués vers les méthodes de l’interface IVstrackProjectDocuments3.Solution Explorer and projects call this interface in response to calls made to the methods of the IVstrackProjectDocuments3 interface. Le contrôle de code source VSPackage peut effectuer le suivi des opérations par lots, synchronisées opérations de lecture/écriture et travailler avec un plus avancées OnQueryAddFiles (méthode).The source control VSPackage can track batched operations, synchronized read/write operations, and work with a more advanced OnQueryAddFiles method. Contrôle de code source VSPackageSource control VSPackage RecommandéRecommended
IVsSccEnlistmentPathTranslation Cette interface fournit la prise en charge de gestion de l’inscription pour les projets Web.This interface provides enlistment management support for Web projects. Contrôle de code source VSPackageSource control VSPackage RecommandéRecommended
IVsSccManagerTooltip Cette interface est utilisée pour récupérer des info-bulles pour les fichiers sous contrôle de code source dans les projets.This interface is used to retrieve ToolTips for the source-controlled files in the projects. Contrôle de code source VSPackageSource control VSPackage FacultatifOptional
IVsSccOpenFromSourceControl Cette interface fournit des extensions de prise en charge.This interface provides namespace extension support. Contrôle de code source VSPackageSource control VSPackage FacultatifOptional
IVsSccControlNewSolution Le VSPackage utilise cette interface pour intégrer une extension de l’espace de noms dans le nouveau, ouvrir, ou enregistrer boîtes de dialogue.The VSPackage uses this interface to integrate a namespace extension into the New, Open, or Save dialog boxes. Par conséquent, les projets peuvent être automatiquement ajoutés au contrôle de code source lors de la création ou ajoutés au contrôle de code source lorsqu’une sauvegarde l’opération est en vigueur.Consequently, projects can be automatically added to source control on creation, or added to source control when a save operation is in effect. Contrôle de code source VSPackageSource control VSPackage FacultatifOptional
IVsSccGlyphs Le VSPackage utilise cette interface pour définir des glyphes supplémentaires comme des glyphes de contrôle de source pour les nœuds de l’Explorateur de solutions.The VSPackage uses this interface to define additional glyphs as source control glyphs for nodes in Solution Explorer. Contrôle de code source VSPackageSource control VSPackage FacultatifOptional
IVsSccAddWebProjectFromSourceControl Le ajouter boîte de dialogue pour les projets Web utilise cette interface.The Add dialog box for Web projects uses this interface. Il fournit des méthodes pour la navigation d’un emplacement de contrôle de code source et de l’ouverture d’un projet Web ajouté précédemment dans le référentiel de contrôle de code source à cet emplacement.It provides methods for browsing for a source control location and for opening a Web project previously added in the source control repository at that location. Contrôle de code source VSPackageSource control VSPackage RecommandéRecommended
IVsAsynchOpenFromScc Cette interface prend en charge pour le chargement asynchrone (en arrière-plan) des projets à partir du contrôle de code source.This interface provides support for asynchronous (background) loading of projects from source control. Contrôle de code source VSPackageSource control VSPackage FacultatifOptional
IVsAsynchOpenFromSccProjectEvents Cette interface permet aux projets de surveiller la progression du chargement asynchrone initiée par IVsAsynchOpenFromScc.This interface allows projects to watch the progress of asynchronous loading initiated by IVsAsynchOpenFromScc. ProjetProject FacultatifOptional
IVsSccToolsOptions Cette interface permet à l’IDE interroger le VSPackage du contrôle source active.This interface allows the IDE to query the active source control VSPackage. L’IDE interroge la valeur de paramètres de contrôle de source qui ont une signification même lorsqu’il n’existe aucun contrôle source active que VSPackage inscrit.The IDE queries the value of source control settings that have meaning even when there is no active source control VSPackage registered. Cette interface est implémentée et gérée par Visual StudioVisual Studio.This interface is implemented and handled by Visual StudioVisual Studio. Stub de contrôle de code sourceSource Control Stub ObligatoireRequired
IVsRegisterScciProvider Cette interface est utilisée lors de l’inscription du contrôle de code source VSPackage.This interface is used in registering the source control VSPackage. Stub de contrôle de code sourceSource Control Stub ObligatoireRequired
SourceControl Cette interface est utilisée dans automation.This interface is used in automation. Par conséquent, il expose uniquement les fonctions qui peuvent être exécutées sans afficher d’interface utilisateur.As such, it exposes only functions that can be executed without displaying any UI. Contrôle de code source VSPackageSource control VSPackage FacultatifOptional
IVsPersistSolutionProps Cette interface est utilisée pour enregistrer des paramètres de contrôle de la source dans le fichier solution (.sln).This interface is used to save the source control settings in the solution (.sln) file. Les paramètres incluent l’emplacement du contrôle de code source et les indicateurs d’état de contrôle de code source.The settings include the source control location and source control status flags. Contrôle de code source VSPackageSource control VSPackage RecommandéRecommended
IVsPersistSolutionOpts Cette interface est utilisée pour enregistrer les paramètres de contrôle de code source dans le fichier d’options (.suo) de solution.This interface is used to save the source control settings in the solution options (.suo) file. Cela peut inclure des paramètres de contrôle de source de spécifiques à l’utilisateur comme emplacement de l’inscription de l’utilisateur actuel.This may include user-specific source control settings such as the current user's enlistment location. Contrôle de code source VSPackageSource control VSPackage RecommandéRecommended
IVsSolutionEvents3 Cette interface est utilisée pour contrôler des événements afin d’effectuer des opérations telles que l’archivage des fichiers projet avant de fermer les solutions, ou l’obtention de nouveaux fichiers à partir du contrôle de code source lors de l’ouverture d’un projet.This interface is used to monitor events in order to perform operations such as checking in project files before closing solutions, or getting new files from source control when opening a project. Contrôle de code source VSPackageSource control VSPackage RecommandéRecommended

Voir aussiSee Also

Éléments de conception.Design Elements