Freigeben über

MSSCCPRJ. SCC-Datei

Wenn Sie eine Visual Studio-Projektmappe oder ein Projekt mithilfe der IDE unter Quellcodeverwaltung platzieren, empfängt die IDE zwei wichtige Informationen. Die Informationen stammen aus dem Quellcodeverwaltungs-Plug-In in Form von Zeichenfolgen. Diese Zeichenfolgen, "AuxPath" und "ProjName", sind für die IDE undurchsichtig, werden jedoch vom Plug-In verwendet, um die Lösung oder das Projekt in der Versionssteuerung zu finden. Die IDE ruft diese Zeichenfolgen in der Regel zum ersten Mal durch Aufrufen des SccGetProjPath ab und speichert sie dann in der Lösungs- oder Projektdatei für zukünftige Aufrufe des SccOpenProject. Wenn sie in die Projektmappen- und Projektdateien eingebettet sind, werden die Zeichenfolgen "AuxPath" und "ProjName" nicht automatisch aktualisiert, wenn ein Benutzer Lösungs- und Projektdateien kopiert, die sich in der Versionssteuerung befinden. Um sicherzustellen, dass die Lösungs- und Projektdateien auf ihren richtigen Speicherort in der Versionssteuerung verweisen, müssen Benutzer die Zeichenfolgen manuell aktualisieren. Da die Zeichenfolgen undurchsichtig sein sollen, ist möglicherweise nicht immer klar, wie sie aktualisiert werden sollen.

Das Quellcodeverwaltungs-Plug-In kann dieses Problem vermeiden, indem die Zeichenfolgen "AuxPath" und "ProjName" in einer speziellen Datei mit dem Namen MSSCCPRJ.SCC gespeichert werden. Es handelt sich um eine lokale clientseitige Datei, die dem Plug-In gehört und Standard. Diese Datei wird niemals unter Quellcodeverwaltung platziert, wird aber vom Plug-In für jedes Verzeichnis generiert, das quellgesteuerte Dateien enthält. Um zu ermitteln, welche Dateien Visual Studio-Lösungs- und Projektdateien sind, kann ein Quellcodeverwaltungs-Plug-In die Dateierweiterungen mit einer Standardliste oder einer vom Benutzer bereitgestellten Liste vergleichen. Sobald die IDE erkennt, dass ein Plug-In die MSSCCPRJ.SCC-Datei unterstützt, werden die Zeichenfolgen "AuxPath" und "ProjName" nicht mehr in Lösungs- und Projektdateien eingebettet, und stattdessen werden diese Zeichenfolgen aus der DATEI MSSCCPRJ.SCC gelesen.

Ein Quellcodeverwaltungs-Plug-In, das die MSSCCPRJ.SCC-Datei unterstützt, muss den folgenden Richtlinien entsprechen:

  • Pro Verzeichnis kann nur eine MSSCCPRJ.SCC-Datei vorhanden sein.

  • Eine MSSCCPRJ.SCC-Datei kann den "AuxPath" und "ProjName" für mehrere Dateien enthalten, die in einem bestimmten Verzeichnis unter quellcodeverwaltung sind.

  • Die AuxPath-Zeichenfolge darf keine Anführungszeichen enthalten. Es ist zulässig, Anführungszeichen als Trennzeichen zu verwenden (z. B. kann ein Paar doppelte Anführungszeichen verwendet werden, um eine leere Zeichenfolge anzugeben). Die IDE entfernt alle Anführungszeichen aus der AuxPath-Zeichenfolge, wenn sie aus der MSSCCPRJ.SCC-Datei gelesen wird.

  • Die Zeichenfolge "ProjName" in der MSSCCPRJ. Die SCC-Datei muss exakt mit der von der SccGetProjPath Funktion zurückgegebenen Zeichenfolge übereinstimmen. Wenn die von der Funktion zurückgegebene Zeichenfolge Anführungszeichen enthält, muss die Zeichenfolge in der DATEI MSSCCPRJ.SCC Anführungszeichen enthalten und umgekehrt.

  • Eine MSSCCPRJ.SCC-Datei wird erstellt oder aktualisiert, wenn eine Datei unter Quellcodeverwaltung platziert wird.

  • Wenn eine MSSCCPRJ.SCC-Datei gelöscht wird, sollte ein Anbieter sie beim nächsten Ausführen eines Quellcodeverwaltungsvorgangs für dieses Verzeichnis neu generieren.

  • Eine MSSCCPRJ.SCC-Datei muss streng dem definierten Format folgen.

Eine Abbildung der MSSCCPRJ. SCC-Dateiformat

Es folgt ein Beispiel für das MSSCCPRJ.SCC-Dateiformat (die Zeilennummern werden nur als Leitfaden bereitgestellt und sollten nicht im Dateitext enthalten sein):

  • [Zeile 1] SCC = This is a Source Code Control file

  • [Zeile 2]

  • [Zeile 3] [TestApp.sln]

  • [Zeile 4] SCC_Aux_Path = "\\server\vss\"

  • [Zeile 5] SCC_Project_Name = "$/TestApp"

  • [Zeile 6]

  • [Zeile 7] [TestApp.csproj]

  • [Zeile 8] SCC_Aux_Path = "\\server\vss\"

  • [Zeile 9] SCC_Project_Name = "$/TestApp"

Die erste Zeile gibt den Zweck der Datei an und dient als Signatur für alle Dateien dieses Typs. Diese Zeile sollte genau wie in allen MSSCCPRJ.SCC-Dateien angezeigt werden:

SCC = This is a Source Code Control file

Im folgenden Abschnitt werden die Einstellungen für jede Datei beschrieben, die durch den Dateinamen in eckigen Klammern gekennzeichnet ist. Dieser Abschnitt wird für jede Datei wiederholt, die nachverfolgt wird. Diese Zeile ist ein Beispiel für einen Dateinamen, nämlich . [TestApp.csproj] Die IDE erwartet die folgenden beiden Zeilen. Es definiert jedoch nicht die Formatvorlage der definierten Werte. Die Variablen sind SCC_Aux_Path und SCC_Project_Name.

SCC_Aux_Path = "\\server\vss\"

SCC_Project_Name = "$/TestApp"

Dieser Abschnitt enthält kein Endtrennzeichen. Der Name der Datei sowie alle Literale, die in der Datei angezeigt werden, werden in der Headerdatei "scc.h" definiert. Weitere Informationen finden Sie unter "Zeichenfolgen", die als Schlüssel zum Suchen eines Quellcodeverwaltungs-Plug-Ins verwendet werden.

Siehe auch