Gewusst wie: Richten Sie ein Quellcodeverwaltungs-Plug-In
Das Erstellen eines Quellcodeverwaltungs-Plug-In umfasst drei Schritte ein:
Erstellen Sie eine DLL mit Funktionen, die im Quellcodeverwaltungs-Plug-In-API-Referenz-Abschnitt dieser Dokumentation definiert sind.
Implementieren Sie das Quellcodeverwaltungs-Plug-In API-definierten Funktionen. Wenn Visual Studio Aufrufe für diese Dialogfelder und Schnittstellen, die vom Plug-In bereitgestellt werden.
Registrieren Sie die DLL, indem Sie die entsprechenden Registrierungseinträge machen.
Integration in Visual Studio
Visual Studio Quellcodeverwaltung unterstützt steckverbindungen, die für das Quellcodeverwaltungs-Plug-In API entsprechen.
Das Registrieren Quellcodeverwaltungs-Plug-In
Bevor eine laufende integrierte Entwicklungsumgebung (IDE) ins Quellcodeverwaltungssystem aufrufen kann, muss sie zuerst das Quellcodeverwaltungs-Plug-In DLL, die die API exportiert.
So erstellen Sie das Quellcodeverwaltungs-Plug-In DLL registrieren
Fügen Sie zwei Einträge im HKEY_LOCAL_MACHINE-Taste unter der SOFTWARE-Unterschlüssel hinzu, der den Firmennamen unterschlüssel angibt, aus dem der Produktname unterschlüssel folgt. Das Muster ist HKEY_LOCAL_MACHINE \ SOFTWARE \[Firmenname]\ \[Produktname]Wert =[Eintrag] . Die beiden Einträge werden immer SCCServerName und SCCServerPath aufgerufen. Jede ist eine normale Zeichenfolge.
Wenn beispielsweise der Firmenname und das Microsoft produkt SourceSafe Quellcodeverwaltung, dann der Registrierungspfad zu HKEY_LOCAL_MACHINE \ SOFTWARE \ Microsoft \ SourceSafe. In diesem Unterschlüssel ist der erste Eintrag, SCCServerName, eine für den Benutzer lesbare Zeichenfolge, die das Produkt benannt werden. Der zweite Eintrag, SCCServerPath, ist der vollständige Pfad für das Quellcodeverwaltungs-Plug-In DLL, die die IDE eine Verbindung herstellen soll. Das folgende Beispiel stellt registrierungseinträge:
Beispielregistrierungseintrag
Wert des Beispiels
HKEY_LOCAL_MACHINE \ SOFTWARE \ Microsoft \ SCCServerName \ SourceSafe
Microsoft Visual SourceSafe
HKEY_LOCAL_MACHINE \ SOFTWARE \ Microsoft \ SCCServerPath \ SourceSafe
c:\vss\win32\ssscc.dll
Hinweis
Das SCCServerPath ist der vollständige Pfad des SourceSafe-Plug-In.Das Quellcodeverwaltungs-Plug-In verwendet verschiedene Unternehmens- und Produktnamen aber die gleichen Pfad Registrierungseintrags.
Die folgenden optionalen Registrierungseinträge können verwendet werden, um das Verhalten des Quellcodeverwaltungs-Plug-In zu ändern. Diese Einträge wechseln in den gleichen Unterschlüssel wie SccServerName und SccServerPath.
Der HideInVisualStudioregistry-Eintrag kann verwendet werden, wenn Sie das Quellcodeverwaltungs-Plug-In nicht in der steckbaren Auswahlliste von Visual Studioangezeigt werden soll. Dieser Eintrag wirkt sich auch auf die automatische den Wechsel in den Quellcodeverwaltungs-Plug-In. Eine mögliche Verwendung für diesen Eintrag Quellcodeverwaltung, wenn Sie ein Paket bereitstellen, das das Quellcodeverwaltungs-Plug-In ersetzt, aber Sie möchten es einfacher zu machen, damit der Benutzer für die Verwendung des Quellcodeverwaltungs-Plug-In Quellcodeverwaltung dem Paket migriert. Wenn das Paket Quellcodeverwaltung installiert ist, legt es diesen Registrierungseintrag ab, der das Plug-In ausblendet.
HideInVisualStudio ist ein DWORD-Wert wird auf 1 festgelegt, und das Plug-In aus- oder 0, um das Plug-In anzuzeigen. Wenn der Registrierungseintrag nicht angezeigt wird, ist das Standardverhalten, das Plug-In anzuzeigen.
Der DisableSccManager-Registrierungseintrag kann verwendet werden, um die Starten <Source Control Server> Menüoption zu deaktivieren oder auszublenden, die in der Regel unter Datei - Untermenü > Quellcodeverwaltung angezeigt wird. Die Menüoption ausgewählt werden, ruft die SccRunScc-Funktion-Funktion an. Das Quellcodeverwaltungs-Plug-In externe Programm nicht unterstützt werden und daher sollten Sie die Starten Menüoption deaktivieren oder sogar ausblenden.
DisableSccManager ist ein DWORD-Wert wird auf 0 festgelegt, um die Starten <Source Control Server> Menüoption zu aktivieren, legen Sie 1 an, um die Menüoption zu deaktivieren und um 2 festgelegt ist, die Menüoption auszublenden. Wenn dieser Registrierungseintrag nicht angezeigt wird, ist das Standardverhalten, die Menüoption angezeigt.
Beispielregistrierungseintrag
Wert des Beispiels
HKEY_LOCAL_MACHINE \ SOFTWARE \ Microsoft \ HideInVisualStudio \ SourceSafe
1
HKEY_LOCAL_MACHINE \ SOFTWARE \ Microsoft \ DisableSccManager \ SourceSafe
1
Fügen Sie den Unterschlüssel, SourceCodeControlProvider unter der HKEY_LOCAL_MACHINE-Taste im SOFTWARE-Unterschlüssel hinzu.
Unterhalb dieses Unterschlüssel wird der Registrierungseintrag ProviderRegKey auf eine Zeichenfolge festgelegt, die den Unterschlüssel darstellt, den Sie in die Registrierung in Schritt 1 haben. Das Muster ist HKEY_LOCAL_MACHINE \ SOFTWARE \ SourceCodeControlProvider \ ProviderRegKey = SOFTWARE \[Firmenname]\[Produktname].
Im folgenden Beispiel wird die Unterschlüssel für diesen Inhalt.
Registrierungseintrag
Wert des Beispiels
HKEY_LOCAL_MACHINE \ SOFTWARE \ SourceCodeControlProvider \ ProviderRegKey
SOFTWARE \ Microsoft \ SourceSafe
Hinweis
Das Quellcodeverwaltungs-Plug-In verwendet den gleichen Unterschlüssel und Eintragsnamen, aber der Wert ist identisch.
Erstellen Sie einen Unterschlüssel unter dem InstalledSCCProviders, der SourceCodeControlProvider-Unterschlüssel, und fügen Sie anschließend einen Unterschlüssel unter diesen Eintrag.
Der Name dieses Eintrags ist der Name des Anbieters für den Benutzer lesbare (derselbe wie der Wert für den angegebenen SCCServerName-Eintrag), und der Wert ist, der der Unterschlüssel noch einmal in Schritt 1 erstellt wird. Das Muster ist HKEY_LOCAL_MACHINE \ SOFTWARE \ SourceCodeControlProvider \ InstalledSCCProviders \[Name] = SOFTWARE \[Firmenname]\[Produktname].
Beispiele:
Beispielregistrierungseintrag
Wert des Beispiels
HKEY_LOCAL_MACHINE \ SOFTWARE \ Microsoft \ InstalledSCCProviders \ SourceCodeControlProvider Visual SourceSafe
SOFTWARE \ Microsoft \ SourceSafe
Hinweis
Es kann mehrere steckverbindungen Quellcodeverwaltung, die auf diese Weise registriert werden.Dies ist das Visual Studio alle installierten Plug-Ins API-basierten das Quellcodeverwaltungs-Plug-In gesucht werden soll.
Wie ein IDE die DLL gefunden
Das Visual Studio IDE bietet zwei Möglichkeiten des Suchens von Quellcodeverwaltungs-Plug-In DLLs:
Suchen Sie das Quellcodeverwaltungs-Plug-In Standard und stellen Sie eine Verbindung mit es automatisch an.
Suchen Sie alle registrierten steckverbindungen Quellcodeverwaltung, aus der der Benutzer ein Element auswählt.
Um die DLL in die erste Art zu suchen, sucht das unter dem Knoten HKEY_LOCAL_MACHINE \ IDE \ SourceCodeControlProvider-Unterschlüssel im Software- nach dem Eintrag ProviderRegKey. Der Wert dieser Einstiegspunkte in einen anderen Unterschlüssel. Die IDE sucht dann nach einem Eintrag, der SccServerPath in diesem zweiten Unterschlüssel unter HKEY_LOCAL_MACHINE benannt ist. Der Wert dieser Einstiegspunkte die IDE auf die DLL.
Hinweis
Die IDE lädt keine DLL von relativen Pfaden (z. B.\ NewProvider.DLL).Ein vollständiger Pfad für die DLL muss (z. B. c:\Providers\NewProvider.DLL) angegeben werden.Dadurch wird die Sicherheit der IDE verstärkt, indem Sie das Laden von nicht autorisierten oder imitierten Plug-In DLL verhindert.
Um die DLL in die zweite Art zu suchen, sucht die IDE unter dem Knoten HKEY_LOCAL_MACHINE \ \. \ SourceCodeControlProvider- Software- InstalledSCCProviders-Unterschlüssel nach allen Einträgen*.* Jeder Eintrag verfügt über einen Namen und einen Wert. Die IDE zeigt eine Liste dieser Namen für den Benutzeran. Wenn der Benutzer einen Namen auswählen, sucht die IDE den Wert für den ausgewählten Namen, der auf einen Unterschlüssel zeigt. Die IDE sucht nach einem Eintrag, der in diesem SccServerPath Unterschlüssel unter HKEY_LOCAL_MACHINE benannt ist. Der Wert der Einstiegspunkte die IDE in den richtigen DLL.
Ein Quellcodeverwaltungs-Plug-In müssen beide Methoden des Suchens und für die Unterstützung der DLL folglich ProviderRegKey fest und überschreibt alle vorherige Einstellung. Wichtiger, muss sie der Liste der InstalledSccProviders hinzufügen, sodass der Benutzer eine Auswahl haben, von der zu verwendenden das Quellcodeverwaltungs-Plug-In.
Hinweis
Da die HKEY_LOCAL_MACHINE-Taste verwendet wird, sondern lediglich ein Quellcodeverwaltungs-Plug-In als die standardmäßige Quellcodeverwaltungs-Plug-In auf einem angegebenen Computer registriert werden kann (zulässig, jedoch Visual Studio Benutzern, um zu bestimmen, welche Quellcodeverwaltungs-Plug-In sie für eine bestimmte Projektmappe tatsächlich verwenden möchten).Während des Installationsvorgangs Überprüfen, ob ein Quellcodeverwaltungs-Plug-In bereits festgelegt ist. Wenn dies der Fall ist, fragen Sie den Benutzer an, ob das neue Quellcodeverwaltungs-Plug-In festgelegt wird, das als Standard installiert ist.Während der Deinstallation Entfernen Sie keine anderen Registrierungsunterschlüssel für alle in steckverbindungen Quellcodeverwaltung HKEY_LOCAL_MACHINE \ SOFTWARE \ SourceCodeControlProvider gemeinsam sind. Entfernen Sie nur den untergeordneten Unterschlüssel bestimmten SCC.
Wie die IDE Unterstützung der Versions-1.2/1.3 erkennt
Wie Visual Studio erkennt, ob ein Plug-In Version 1.2 und 1.3 unterstützt Funktionen Quellcodeverwaltungs-Plug-In API? Um erweiterte Funktion zu deklarieren, muss das Quellcodeverwaltungs-Plug-In die entsprechende Funktion implementieren.
Zuerst überprüft Visual Studio den Wert, der zurückgegeben wird, mithilfe SccGetVersion-Funktionaufruft. Es muss größer oder gleich 1.2 sein.
Anschließend bestimmt Visual Studio , ob die bestimmte neue Funktion unterstützt wird, indem das Argument in lpSccCapsSccInitialize-Funktionüberprüft.
Wenn beide Bedingungen erfüllt sind, unterstützen die neuen Funktionen in den Versionen 1.2 und 1.3 können aufgerufen werden.