Verwandte Dienste und Schnittstellen (Quellcodeverwaltungs-VSPackage)
In diesem Abschnitt werden alle VSPackage-bezogenen Schnittstellen für die Quellcodeverwaltung im Visual Studio SDK aufgeführt. Das Quellcodeverwaltungs-VSPackage implementiert einige dieser Schnittstellen und verwendet andere zum Ausführen von Quellcodeverwaltungsaufgaben.
Von und für Quellcodeverwaltung VSPackages implementierte Schnittstellen
Die folgenden Schnittstellen werden im Visual Studio SDK beschrieben, und das Quellcodeverwaltungs-VSPackage implementiert je nach gewünschtem Featuresatz eine Teilmenge davon. Einige Schnittstellen sind als erforderlich gekennzeichnet und müssen von jeder Quellcodeverwaltung VSPackage implementiert werden.
Für schnittstellen, die ein Paket nicht implementiert, stellt Visual Studio eine Standardimplementierung bereit. Beachten Sie, dass die Standardimplementierung für den Fall konzipiert ist, wenn kein VSPackage registriert ist und kein Projekt gesteuert wird. Ein ordnungsgemäß geschriebenes Quellcodeverwaltungs-VSPackage implementiert alle erforderlichen Schnittstellen, anstatt sie der Standardimplementierung dieser Schnittstellen zu überlassen.
Ein Quellcodeverwaltungs-VSPackage muss einen privaten Dienst implementieren, der einige oder alle der folgenden Schnittstellen kapselt.
Schnittstellen sind:
Erforderlich: Die entsprechende Entität (Quellcodeverwaltung VSPackage, Source Control Stub, Projekt) muss die Schnittstelle implementieren.
Empfohlen: Die Entität sollte diese Schnittstelle implementieren; andernfalls kann die Funktionalität der Quellcodeverwaltung eingeschränkt sein.
Optional: Die Entität kann diese Schnittstelle implementieren, um einen umfangreicheren Featuresatz bereitzustellen.
| Schnittstelle | Zweck | Implementiert von | Implementieren? |
|---|---|---|---|
| IVsQueryEditQuerySave2 | Editoren rufen diese Schnittstelle auf, bevor Sie eine Datei ändern oder speichern. Die Quellcodeverwaltung VSPackage kann die Datei auschecken oder den Vorgang verweigern, wenn das Auschecken fehlschlägt. | Quellcodeverwaltung VSPackage | Empfohlen |
| IVsSccManager2 | Diese Schnittstelle bietet grundlegende Quellcodeverwaltungsfunktionen für Projekte, z. B. registrieren und aufheben der Registrierung von Projekten mit Quellcodeverwaltung und Unterstützung für grundlegende Quellcodeverwaltungsglyphen. | Quellcodeverwaltung VSPackage | Erforderlich |
| IVsSccProject2 | Diese Schnittstelle wird aus der Verwendung der IVsHierarchy QueryInterface Funktion oder durch einfaches Umwandeln des Objekts abgerufen, das implementiert wird IVsHierarchy IVsSccProject2. Es wird verwendet, um die Dateien unter quellcodeverwaltung in einem Projekt zu erhalten oder um das Projekt über den aktuellen Quellcodeverwaltungsstatus oder den aktuellen Speicherort zu informieren. |
Projekt | Erforderlich |
| IVsSccProvider | Das Integrationsmodul verwendet diese Schnittstelle, um das aktuelle aktive VSPackage festzulegen. | Quellcodeverwaltung VSPackage | Erforderlich |
| IVsTrackProjectDocuments2 | Diese Schnittstelle basiert auf einem Abonnementmodell. Jedes VSPackage kann signalisieren, dass es Dokumentereignisse empfangen möchte und von der Shell zu Ereignissen beraten werden soll, die in der Regel stattfinden. Sie wird von Visual Studio implementiert und behandelt, was wiederum Ereignisse übergibt, die an IVsTrackProjectDocumentsEvents2 vsPackage implementiert werden. |
Quellcodeverwaltungs-Stub | Erforderlich |
| IVsTrackProjectDocuments3 | Diese Schnittstelle bietet Batchverarbeitung, synchronisierte Lese-/Schreibvorgänge und eine erweiterte OnQueryAddFiles Methode. |
Quellcodeverwaltungs-Stub | Erforderlich |
| IVsTrackProjectDocumentsEvents2 | Projektmappen-Explorer und Projekte rufen diese Schnittstelle auf, wenn neue Dateien zu den Projekten hinzugefügt werden, oder wenn Dateien und Ordner umbenannt oder aus Projekten gelöscht werden. Die Quellcodeverwaltung VSPackage kann die Projektdatei auschecken oder den Vorgang abbrechen. | Quellcodeverwaltung VSPackage | Empfohlen |
| IVsTrackProjectDocumentsEvents3 | Projektmappen-Explorer und Projekte rufen diese Schnittstelle als Reaktion auf Aufrufe der IVstrackProjectDocuments3-Schnittstelle auf. Die Quellcodeverwaltung VSPackage kann Batchvorgänge, synchronisierte Lese-/Schreibvorgänge nachverfolgen und mit einer komplexeren OnQueryAddFiles Methode arbeiten. |
Quellcodeverwaltung VSPackage | Empfohlen |
| IVsSccEnlistmentPathTranslation | Diese Schnittstelle bietet Unterstützung für die Verwaltung von Listen für Webprojekte. | Quellcodeverwaltung VSPackage | Empfohlen |
| IVsSccManagerTooltip | Diese Schnittstelle wird verwendet, um Tool Tipps für die quellgesteuerten Dateien in den Projekten abzurufen. | Quellcodeverwaltung VSPackage | Optional |
| IVsSccOpenFromSourceControl | Diese Schnittstelle bietet Unterstützung für Namespaceerweiterungen. | Quellcodeverwaltung VSPackage | Optional |
| IVsSccControlNewSolution | Das VSPackage verwendet diese Schnittstelle, um eine Namespaceerweiterung in die Dialogfelder "Neu", "Öffnen" oder "Speichern " zu integrieren. Folglich können Projekte automatisch zur Quellcodeverwaltung bei der Erstellung hinzugefügt oder zur Quellcodeverwaltung hinzugefügt werden, wenn ein Speichervorgang wirksam ist. | Quellcodeverwaltung VSPackage | Optional |
| IVsSccGlyphs | Das VSPackage verwendet diese Schnittstelle, um zusätzliche Glyphen als Quellcodeverwaltungsglyphen für Knoten in Projektmappen-Explorer zu definieren. | Quellcodeverwaltung VSPackage | Optional |
| IVsSccAddWebProjectFromSourceControl | Das Dialogfeld "Hinzufügen " für Webprojekte verwendet diese Schnittstelle. Es stellt Methoden zum Suchen nach einem Speicherort für die Quellcodeverwaltung und zum Öffnen eines Webprojekts bereit, das zuvor im Quellcodeverwaltungs-Repository an diesem Speicherort hinzugefügt wurde. | Quellcodeverwaltung VSPackage | Empfohlen |
| IVsAsynchOpenFromScc | Diese Schnittstelle bietet Unterstützung für das asynchrone Laden von Projekten aus der Quellcodeverwaltung .This interface provides support for asynchron (background) loading of projects from source control. | Quellcodeverwaltung VSPackage | Optional |
| IVsAsynchOpenFromSccProjectEvents | Diese Schnittstelle ermöglicht Es Projekten, den Fortschritt des asynchronen Ladens zu beobachten, der von IVsAsynchOpenFromScc. | Projekt | Optional |
| IVsSccToolsOptions | Diese Schnittstelle ermöglicht es der IDE, das aktive Quellcodeverwaltungs-VSPackage abzufragen. Die IDE fragt den Wert der Quellcodeverwaltungseinstellungen ab, die bedeutungslos sind, auch wenn keine aktive Quellcodeverwaltung vsPackage registriert ist. Diese Schnittstelle wird von Visual Studio implementiert und behandelt. | Quellcodeverwaltungs-Stub | Erforderlich |
| IVsRegisterScciProvider | Diese Schnittstelle wird beim Registrieren der Quellcodeverwaltung VSPackage verwendet. | Quellcodeverwaltungs-Stub | Erforderlich |
| SourceControl | Diese Schnittstelle wird in der Automatisierung verwendet. Daher werden nur Funktionen verfügbar gemacht, die ohne Anzeige einer Benutzeroberfläche ausgeführt werden können. | Quellcodeverwaltung VSPackage | Optional |
| IVsPersistSolutionProps | Diese Schnittstelle wird verwendet, um die Quellcodeverwaltungseinstellungen in der Lösungsdatei (SLN) zu speichern. Die Einstellungen umfassen den Speicherort der Quellcodeverwaltung und Statuskennzeichnungen für die Quellcodeverwaltung. | Quellcodeverwaltung VSPackage | Empfohlen |
| IVsPersistSolutionOpts | Diese Schnittstelle wird verwendet, um die Quellcodeverwaltungseinstellungen in der Lösungsoptionendatei (SUO) zu speichern. Dies kann benutzerspezifische Einstellungen für die Quellcodeverwaltung umfassen, z. B. den Speicherort der Aktuellen Benutzerliste. | Quellcodeverwaltung VSPackage | Empfohlen |
| IVsSolutionEvents3 | Diese Schnittstelle wird verwendet, um Ereignisse zu überwachen, um Vorgänge wie das Einchecken von Projektdateien vor dem Schließen von Lösungen oder das Abrufen neuer Dateien aus der Quellcodeverwaltung beim Öffnen eines Projekts auszuführen. | Quellcodeverwaltung VSPackage | Empfohlen |