SccInitialize-Funktion
Diese Funktion initialisiert das Quellcodeverwaltungs-Plug-In und stellt Funktionen und Grenzwerte für die integrierte Entwicklungsumgebung (IDE) bereit.
Syntax
SCCRTN SccInitialize (
LPVOID* ppvContext,
HWND hWnd,
LPCSTR lpCallerName,
LPSTR lpSccName,
LPLONG lpSccCaps,
LPSTR lpAuxPathLabel,
LPLONG pnCheckoutCommentLen,
LPLONG pnCommentLen
);
Parameter
ppvContext
[in] Das Quellcodeverwaltungs-Plug-In kann hier einen Zeiger auf seine Kontextstruktur setzen.
hWnd
[in] Ein Handle für das IDE-Fenster, das das Quellcodeverwaltungs-Plug-In als übergeordnetes Element für alle von ihr bereitgestellten Dialogfelder verwenden kann.
lpCallerName
[in] Der Name des Programms, das das Quellcodeverwaltungs-Plug-In aufruft.
lpSccName
[in, out] Der Puffer, in dem das Quellcodeverwaltungs-Plug-In seinen eigenen Namen (nicht zu überschreiten) eingibt SCC_NAME_LEN.
lpSccCaps
[out] Gibt die Funktionskennzeichnungen des Quellcodeverwaltungs-Plug-Ins zurück.
lpAuxPathLabel
[in, out] Der Puffer, in dem das Quellcodeverwaltungs-Plug-In eine Zeichenfolge einfügt, die den lpAuxProjPath parameter beschreibt, der von SccOpenProject und SccGetProjPath (nicht zu überschreiten) SCC_AUXLABEL_LENzurückgegeben wird.
pnCheckoutCommentLen
[out] Gibt die maximal zulässige Länge für einen Auscheckkommentar zurück.
pnCommentLen
[out] Gibt die maximal zulässige Länge für andere Kommentare zurück.
Rückgabewert
Die Plug-In-Implementierung dieser Funktion für die Quellcodeverwaltung wird voraussichtlich einen der folgenden Werte zurückgeben:
| Wert | Beschreibung |
|---|---|
| SCC_OK | Die Initialisierung der Quellcodeverwaltung war erfolgreich. |
| SCC_E_INITIALIZEFAILED | Das System konnte nicht initialisiert werden. |
| SCC_E_NOTAUTHORIZED | Der Benutzer darf den angegebenen Vorgang nicht ausführen. |
| SCC_E_NONSPECFICERROR | Nicht spezifischer Fehler; Das Quellcodeverwaltungssystem wurde nicht initialisiert. |
Hinweise
Die IDE ruft diese Funktion auf, wenn sie das Quellcodeverwaltungs-Plug-In zum ersten Mal lädt. Es ermöglicht der IDE, bestimmte Informationen, z. B. den Namen des Aufrufers, an das Plug-In zu übergeben. Die IDE erhält auch bestimmte Informationen wie die maximal zulässige Länge für Kommentare und die Funktionen des Plug-Ins zurück.
Die ppvContext Punkte auf einen NULL Zeiger. Das Quellcodeverwaltungs-Plug-In kann eine Struktur für die eigene Verwendung zuweisen und einen Zeiger auf diese Struktur speichern.ppvContext Die IDE übergibt diesen Zeiger an jede andere VSSCI-API-Funktion, sodass das Plug-In Kontextinformationen zur Verfügung stellt, ohne auf den globalen Speicher zurückgreifen zu müssen und mehrere Instanzen des Plug-Ins zu unterstützen. Diese Struktur sollte beim Aufrufen der SccUninitialize behandelt werden.
Mit lpCallerName den Parametern lpSccName können die IDE und das Quellcodeverwaltungs-Plug-In Namen austauschen. Diese Namen können einfach verwendet werden, um zwischen mehreren Instanzen zu unterscheiden, oder sie werden tatsächlich in Menüs oder Dialogfeldern angezeigt.
Der lpAuxPathLabel Parameter ist eine Zeichenfolge, die als Kommentar verwendet wird, um den Hilfsprojektpfad zu identifizieren, der in der Lösungsdatei gespeichert ist und an das Quellcodeverwaltungs-Plug-In in einem Aufruf des SccOpenProject übergeben wird. Visual Source Tresor verwendet die Zeichenfolge "Source Tresor Project:"; Andere Quellcodeverwaltungs-Plug-Ins sollten diese bestimmte Zeichenfolge nicht verwenden.
Der lpSccCaps Parameter gibt dem Quellcodeverwaltungs-Plug-In einen Ort zum Speichern von Bitflags, der die Funktionen des Plug-Ins angibt. (Eine vollständige Liste der Funktionsbitflags finden Sie unter Funktionskennzeichnungen). Wenn das Plug-In z. B. Ergebnisse in eine caller-bereitgestellte Rückruffunktion schreiben möchte, würde das Plug-In die Funktion bit SCC_CAP_TEXTOUT festlegen. Dadurch würde die IDE signalisiert, ein Fenster für Versionssteuerungsergebnisse zu erstellen.