SccAddFromScc-Funktion
Diese Funktion ermöglicht es dem Benutzer, die nach Dateien zu durchsuchen, die bereits im Quellcodeverwaltungssystem sind und die Datei anschließend aus dem aktuellen Projekt gehört. Beispielsweise kann diese Funktion eine allgemeine Headerdatei in das aktuelle Projekt stammen, ohne die Dateien zu kopieren. Das zurückgegebene Zeichenfolgenarray von Dateien, lplpFileNames, enthält die Liste der Dateien, die der Benutzer dem IDE-Projekt hinzufügen möchte.
SCCRTN SccAddFromScc (
LPVOID pvContext,
HWND hWnd,
LPLONG lpnFiles,
LPCSTR** lplpFileNames
);
Parameter
pvContext
[in] Die Quellcodeverwaltungs-Plug-In-Kontext Struktur.hWnd
[in] Ein Handle für das IDE-Fenster, das das Quellcodeverwaltungs-Plug-In als übergeordnetes Element für alle Dialogfelder verwenden kann, die er bereitstellt.lpnFiles
[in, out] Ein Puffer für die Anzahl der Dateien, die hinzugefügt werden. (Dies ist NULL , wenn der Speicher, der von lplpFileNames gezeigte freigegeben werden soll. Siehe Hinweise.)lplpFileNames
[in, out] Ein Array von Zeigern auf allen Dateinamen ohne Verzeichnispfade. Dieses Array wird durch das Quellcodeverwaltungs-Plug-In reserviert und freigegeben. Wenn lpnFiles = 1 und lplpFileNames nicht NULList, enthält der Vorname in dem Array, das durch lplpFileNames gezeigte den Zielordner.
Rückgabewert
Die Quellcodeverwaltungs-Plug-In-Implementierung dieser Funktion wird erwartet, dass es sich um einen der folgenden Werte zurückgeben:
Wert |
Beschreibung |
|---|---|
SCC_OK |
Die Dateien wurden erfolgreich saßen und dem Projekt hinzugefügt. |
SCC_I_OPERATIONCANCELED |
Der Vorgang wurde abgebrochen, ohne Auswirkung. |
SCC_I_RELOADFILE |
Eine Datei oder ein Projekt muss erneut geladen werden. |
Hinweise
Die IDE ruft diese Funktion auf. Wenn das Quellcodeverwaltungs-Plug-In das Angeben eines lokalen Zielordners unterstützt, führt die IDE lpnFiles = 1 und führt den lokalen Ordnernamen in lplpFileNames.
Wenn der Aufruf der SccAddFromScc-Funktion einen Wert zurückgibt, hat das Plug-In bestimmte Werte zu lpnFiles und lplpFileNamesund bei Bedarf ordnet den Speicher für den Dateinamen array (Beachten Sie, dass diese Zuordnung den Zeiger in lplpFileNamesersetzt). Das Quellcodeverwaltungs-Plug-In ist für das Versehen aller Dateien im Benutzerverzeichnis oder in den angegebenen Ordner Bezeichnung verantwortlich. Die IDE fügt anschließend die IDE-Projekt dem Dateien hinzu.
Schließlich ruft die IDE diese Funktion ein zweites Mal auf und übergibt NULL für lpnFiles. Dies ist z. B. ein spezielles Signal für das Quellcodeverwaltungs-Plug-In, Arbeitsspeicher freizugeben, der zum Interpretieren des Dateinamens.zugeordnet ist lplpFileNamesin array
lplpFileNames ist ein char *** Zeiger. Das Quellcodeverwaltungs-Plug-In platziert einen Zeiger auf ein Array von Zeigern auf den Dateinamen, und übergibt die Liste so auf die Art der Standard für diese API.
Hinweis
Ursprüngliche Fassungen des VSSCI angegebene APIs keine Möglichkeit, das Zielprojekt für die hinzugefügten Dateien anzugeben.Um dieses aufnehmen zu lassen, richtet sich die Semantik des lplpFIleNames-Parameters verbessert, um ein In/Out-Parameter anstelle eines Ausgabeparameters.Wenn nur eine einzelne Datei, d. h. der Wert, der durch lpnFiles = 1 dargestellt wird, enthält das erste Element aus lplpFileNames den Zielordner.Um dieses neue Semantik zu verwenden, ruft die IDE die SccSetOption-Funktion mit dem nOptionParameter an, der zu SCC_OPT_SHARESUBPROJfestgelegt ist.Wenn ein Quellcodeverwaltungs-Plug-In die Semantik nicht unterstützt wird, gibt sie SCC_E_OPTNOTSUPPORTEDzurück.Auf diese Weise deaktiviert die Verwendung der Aus der Quellcodeverwaltung hinzufügen-Funktion.Wenn ein Plug-In die Aus der Quellcodeverwaltung hinzufügen-Funktion (SCC_CAP_ADDFROMSCC) unterstützt, muss er die neue Semantik und die Rückgabe SCC_I_SHARESUBPROJOKunterstützen.