API-Funktionen für das Quellcodeverwaltungs-Plug-In

Das Quellcodeverwaltungs-Plug-In API stellt die folgenden Funktionen bereit, die durch das Quellcodeverwaltungs-Plug-In in Übereinstimmung mit diesen APIs implementiert werden müssen. Die Signaturen für jede Funktion und der Semantik, die mit den von Bitflags zugeordnet ist und andere Parameter werden ausführlich in diesem Verweis beschrieben.

Initialisierung und organisatorische Aufgaben

Funktion	Beschreibung
SccCloseProject-Funktion	Schließt ein Projekt.
SccGetCommandOptions-Funktion	Fordert den Benutzer für erweiterte Optionen für den angegebenen Befehl auf.
SccGetVersion-Funktion	Gibt die Version des Quellcodeverwaltungs-Plug-In zurück.
SccInitialize-Funktion	Initialisiert das Quellcodeverwaltungs-Plug-In. Es wird einmal für jede Instanz des Plug-Ins aufgerufen.
SccOpenProject-Funktion	Öffnet ein Projekt.
SccSetOption-Funktion	Eine generische Funktion, die eine Vielzahl von Optionen festzulegen. Beginnt mit jeder Option SCC_OPT_xxx und verfügt über einen eigenen definierten Satz von Werten.
SccUninitialize-Funktion	Einmal aufgerufen, wenn ein Quellcodeverwaltungs-Plug-In herausgezogen werden muss.

Kern-Quellcodeverwaltungs-Funktionen

Funktion	Beschreibung
SccAdd-Funktion	Fügt ein Array von Dateien hinzu, die von voll gekennzeichneten Pfadnamen dem Quellcodeverwaltungssystem angegeben werden.
SccAddFromScc-Funktion	Ermöglicht es dem Benutzer, die nach Dateien zu durchsuchen, die bereits im Quellcodeverwaltungssystem sind und die Datei dann aus dem aktuellen Projekt gehört.
SccCheckin-Funktion	Überprüft in ein Array von Dateien.
SccCheckout-Funktion	Checkt ein Array von Dateien.
SccDiff-Funktion	Zeigt die Unterschiede zwischen der lokalen Datei des Benutzers an, der durch einen vollqualifizierten Pfadnamen angegeben werden, und der Version in der Quellcodeverwaltung.
SccGet-Funktion	Ruft eine schreibgeschützte Kopie einer Gruppe von Dateien ab.
SccGetEvents-Funktion	Überprüft den Status von Dateien, die der Aufrufer ungefähr angefordert hat (zum SccQueryInfo).
SccGetProjPath-Funktion	Bewirkt, dass das Quellcodeverwaltungs-Plug-In, den Projektpfad für einen Benutzer aufzufordern, der dem Plug-In sinnvoll ist.
SccHistory-Funktion	Zeigt den Verlauf für ein Array von vollqualifizierten lokalen Dateinamen an.
SccPopulateList-Funktion	Überprüft die Liste der Dateien für ihren aktuellen Status. Außerdem verwendet die pfnPopulate-Funktion den Aufrufer benachrichtigt, wenn eine Datei nicht den Kriterien für nCommandübereinstimmt.
SccProperties-Funktion	Zeigt die Eigenschaften einer voll gekennzeichneten Datei an.
SccQueryInfo-Funktion	Überprüft eine Liste von voll gekennzeichneten Dateien für ihren aktuellen Status.
SccRemove-Funktion	Entfernt das Array mit vollqualifizierten Dateien vom Quellcodeverwaltungssystem.
SccRename-Funktion	Benennt die angegebene Datei in einem neuen Namen im Quellcodeverwaltungssystem.
SccRunScc-Funktion	Greift auf alle Funktionen des Quellcodeverwaltungssystems an.
SccUncheckout-Funktion	Macht das Auschecken eines Arrays von Dateien.

Funktionen, die zusätzliche Funktion unterstützen (Version 1.2 des Quellcodeverwaltungs-Plug-In API)

Diese Gruppe von Funktionen definiert die zusätzliche Funktionen, die in Version 1.2 des Quellcodeverwaltungs-Plug-In API enthalten ist. Sie ermöglichen den Zugriff auf die Quellcodeverwaltung erweiterte Features und - Funktionen.

Funktion	Beschreibung
SccBeginBatch-Funktion	Startet einen Batchvorgang.
SccCreateSubProject-Funktion	Erstellt ein Unterprojekt mit dem angegebenen Namen unter einem vorhandenen Elementen Projekt.
SccDirDiff-Funktion	Zeigt die Unterschiede zwischen dem lokalen Benutzerverzeichnis an, das durch einen vollqualifizierten Pfadnamen angegeben werden, und dem Quellcodeverwaltungs-Datenbank-Speicherort.
SccDirQueryInfo-Funktion	Überprüft eine Liste von voll gekennzeichneten Verzeichnisse für ihren aktuellen Status.
SccEndBatch-Funktion	Beendet einen Batchvorgang.
SccGetParentProjectPath-Funktion	Gibt übergeordneten Pfad des angegebenen Projekts zurück (das Projekt muss vorhanden sein).
SccIsMultiCheckoutEnabled-Funktion	Überprüft, ob mehrfache Auschecken einer Datei wird.
SccWillCreateSccFile-Funktion	Überprüft, ob das Plug-In MSSCCPRJ.SCC-Dateien erstellt.

Funktionen, die erweiterte Funktion unterstützen (Version 1.3 des Quellcodeverwaltungs-Plug-In API)

Diese Gruppe von Funktionen definiert die zusätzliche Funktionen, die in Version 1.3 des Quellcodeverwaltungs-Plug-In API enthalten ist. Sie ermöglichen den Zugriff auf die Quellcodeverwaltung erweiterte Features und - Funktionen.

Funktion	Beschreibung
SccAddFilesFromSCC-Funktion	Fügt eine Liste von Dateien aus der Quellcodeverwaltung aus dem aktuellen Projekt hinzu.
SccBackgroundGet-Funktion	Ruft eine Liste von Dateien aus der Quellcodeverwaltung ohne eine Benutzeroberfläche ab.
SccEnumChangedFiles-Funktion	Ruft eine Liste mit Dateien in der Quellcodeverwaltung ab, die auf lokale Dateien unterscheidet.
SccGetExtendedCapabilities-Funktion	Ruft Flags ab, die die erweiterten Funktionen angeben, die durch das Quellcodeverwaltungs-Plug-In unterstützt werden.
SccGetUserOption-Funktion	Ruft die benutzerspezifische Optionen ab.
SccPopulateDirList-Funktion	Überprüft eine Liste von Verzeichnissen und Dateien in einem Projekt oder in Projekten, die in die Quellcodeverwaltung einbezogen sind. Jedes Verzeichnis- und Dateinamen, die gefunden werden, wird an eine Rückruffunktion übergeben.
SccQueryChanges-Funktion	Überprüft die Namensänderungen, die an einer Liste von Dateien vorgenommen werden. Jeder Dateiname wird auf eine Rückruffunktion, dessen Änderungsstand übergeben.

Anforderungen

Header: scc.h

(Bei Umgebungs-SDK-Common beinhaltet standardmäßig im Ordner \ Programme \ [Laufwerk]Partner 8.0 \ EnvSDK \ Common \ Inc. ein. ebenfalls angegeben MSSCCI-Beispiel im VSIP-Ordner mit dem Partner, [Laufwerk]\ Programme \ 8.0 \ MSSCCI).

Siehe auch

Weitere Ressourcen

Quellcodeverwaltungs-Plug-Ins

Ein Quellcodeverwaltungs-Plug-In erstellen