API-Funktionen von Quellcodeverwaltungs-Plug-Ins
Die Quellcodeverwaltungs-Plug-In-API stellt die folgenden Funktionen bereit, die vom Quellcodeverwaltungs-Plug-In gemäß dieser API implementiert werden müssen. Die Signaturen jeder Funktion und die Semantik, die den Bitkennzeichnungen und anderen Parametern zugeordnet sind, werden in dieser Referenz ausführlich beschrieben.
Initialisierungs- und Haushaltungsfunktionen
| Funktion | Beschreibung |
|---|---|
| SccCloseProject | Schließt ein Projekt. |
| SccGetCommandOptions | Fordert den Benutzer zur Eingabe erweiterter Optionen für den angegebenen Befehl auf. |
| SccGetVersion | Gibt die Version des Quellcodeverwaltungs-Plug-Ins zurück. |
| SccInitialize | Initialisiert das Quellcodeverwaltungs-Plug-In. Es wird einmal für jede Instanz des Plug-Ins aufgerufen. |
| SccOpenProject | Öffnet ein Projekt. |
| SccSetOption | Eine generische Funktion, die zum Festlegen einer Vielzahl von Optionen verwendet wird. Jede Option beginnt mit SCC_OPT_xxx und verfügt über einen eigenen definierten Wertesatz. |
| SccUninitialize | Wird einmal aufgerufen, wenn ein Quellcodeverwaltungs-Plug-In nicht angeschlossen werden muss. |
Kernfunktionen der Quellcodeverwaltung
| Funktion | Beschreibung |
|---|---|
| SccAdd | Fügt dem Quellcodeverwaltungssystem ein Array von Dateien hinzu, die durch vollqualifizierte Pfadnamen angegeben werden. |
| SccAddFromScc | Ermöglicht es dem Benutzer, nach Dateien zu suchen, die sich bereits im Quellcodeverwaltungssystem befinden, und diese Dateien dann teil des aktuellen Projekts zu machen. |
| SccCheckin | Überprüft ein Array von Dateien. |
| SccCheckout | Checkt ein Array von Dateien aus. |
| SccDiff | Zeigt die Unterschiede zwischen der datei des lokalen Benutzers, die durch einen vollqualifizierten Pfadnamen und die Version unter Quellcodeverwaltung angegeben ist. |
| SccGet | Ruft eine schreibgeschützte Kopie einer Gruppe von Dateien ab. |
| SccGetEvents | Überprüft den Status der Dateien, die der Anrufer gefragt hat (via SccQueryInfo). |
| SccGetProjPath | Bewirkt, dass das Quellcodeverwaltungs-Plug-In den Benutzer zur Eingabe eines Projektpfads auffordert, der für das Plug-In aussagekräftig ist. |
| SccHistory | Zeigt den Verlauf für ein Array vollqualifizierter lokaler Dateinamen an. |
| SccPopulateList | Überprüft die Liste der Dateien auf ihren aktuellen Status. Darüber hinaus verwendet die pfnPopulate Funktion, um den Aufrufer zu benachrichtigen, wenn eine Datei nicht den Kriterien für die nCommand. |
| SccProperties | Zeigt die Eigenschaften einer vollqualifizierten Datei an. |
| SccQueryInfo | Überprüft eine Liste der vollqualifizierten Dateien auf ihren aktuellen Status. |
| SccRemove | Entfernt das Array vollqualifizierter Dateien aus dem Quellcodeverwaltungssystem. |
| SccRename | Benennt die angegebene Datei in einen neuen Namen im Quellcodeverwaltungssystem um. |
| SccRunScc | Greift auf die gesamte Palette von Features des Quellcodeverwaltungssystems zu. |
| SccUncheckout | Rückgängigmachen eines Auscheckens eines Arrays von Dateien. |
Funktionen, die zusätzliche Funktionen unterstützen (Version 1.2 der Quellcodeverwaltungs-Plug-In-API)
Diese Gruppe von Funktionen definiert die zusätzliche Funktionalität, die in Version 1.2 der Quellcodeverwaltungs-Plug-In-API enthalten ist. Sie bieten Zugriff auf erweiterte Quellcodeverwaltungsfeatures und -funktionen.
| Funktion | Beschreibung |
|---|---|
| SccBeginBatch | Startet einen Batchvorgang. |
| SccCreateSubProject | Erstellt ein Teilprojekt mit dem angegebenen Namen unter einem vorhandenen übergeordneten Projekt. |
| SccDirDiff | Zeigt die Unterschiede zwischen dem verzeichnis des lokalen Benutzers, das durch einen vollqualifizierten Pfadnamen und den Speicherort der Quellcodeverwaltungsdatenbank angegeben ist. |
| SccDirQueryInfo | Überprüft eine Liste der vollqualifizierten Verzeichnisse auf ihren aktuellen Status. |
| SccEndBatch | Beendet einen Batchvorgang. |
| SccGetParentProjectPath | Gibt den übergeordneten Pfad des angegebenen Projekts zurück (das Projekt muss vorhanden sein). |
| SccIsMultiCheckoutEnabled | Überprüft, ob mehrere Auscheckvorgänge für eine Datei zulässig sind. |
| SccWillCreateSccFile | Überprüft, ob das Plug-In MSSCCPRJ erstellt. SCC-Dateien. |
Funktionen, die erweiterte Funktionen unterstützen (Version 1.3 der Quellcodeverwaltungs-Plug-In-API)
Diese Gruppe von Funktionen definiert die zusätzliche Funktionalität, die in Version 1.3 der Quellcodeverwaltungs-Plug-In-API enthalten ist. Sie bieten Zugriff auf erweiterte Quellcodeverwaltungsfeatures und -funktionen.
| Funktion | Beschreibung |
|---|---|
| SccAddFilesFromSCC | Fügt dem aktuellen Projekt eine Liste von Dateien aus der Quellcodeverwaltung hinzu. |
| SccBackgroundGet | Ruft eine Liste von Dateien aus der Quellcodeverwaltung ohne Benutzeroberfläche ab. |
| SccEnumChangedFiles | Ruft eine Liste von Dateien in der Quellcodeverwaltung ab, die sich von den lokalen Dateien unterscheiden. |
| SccGetExtendedCapabilities | Ruft Flags ab, die erweiterte Funktionen angeben, die vom Quellcodeverwaltungs-Plug-In unterstützt werden. |
| SccGetUserOption | Ruft benutzerspezifische Optionen ab. |
| SccPopulateDirList | Untersucht eine Liste von Verzeichnissen und Dateien in einem Projekt oder Projekten, die sich unter der Quellcodeverwaltung befinden. Jeder gefundene Verzeichnis- und Dateiname wird an eine Rückruffunktion übergeben. |
| SccQueryChanges | Überprüft namensänderungen, die an einer Liste von Dateien vorgenommen wurden. Jeder Dateiname wird mit seinem Änderungsstatus an eine Rückruffunktion übergeben. |
Anforderungen
Kopfzeile: scc.h
(Standardmäßig im Environment SDK bereitgestellt[Laufwerk]\Programme\VSIP 8.0\EnvSDK\common\inc; außerdem im VSIP-Ordner mit dem MSSCCI-Beispiel, [drive]\Program Files\VSIP 8.0\MSSCCI).