SccPopulateList-Funktion
Diese Funktion aktualisiert eine Liste von Dateien für einen bestimmten Status quellcodeverwaltungs befehls- Quellcodeverwaltung und stellt für alle angegebenen Dateien.
SCCRTN SccPopulateList (
LPVOID pvContext,
enum SCCCOMMAND nCommand,
LONG nFiles,
LPCSTR* lpFileNames,
POPLISTFUNC pfnPopulate,
LPVOID pvCallerData,
LPLONG lpStatus,
LONG fOptions
);
Parameter
pvContext
[in] Die Quellcodeverwaltungs-Plug-In-Kontext Struktur.nCommand
[in] Der Befehl, der Quellcodeverwaltung für alle Dateien im lpFileNames Array angewendet wird (siehe Befehlscode-Enumerator für eine Liste möglicher Commands).nFiles
[in] Die Anzahl der Dateien im lpFileNames Array.lpFileNames
[in] Ein Array von Dateinamen der IDE bezeichnet.pfnPopulate
[in] Die, um Dateien hinzuzufügen und zu entfernen IDE-Rückruffunktion aufrufen (siehe POPLISTFUNC für Details).pvCallerData
[in] Wert, der an die Rückruffunktion unverändert übergeben werden soll.lpStatus
[in, out] Ein Array, sodass das Quellcodeverwaltungs-Plug-In die Statusflags für jede Datei zurückgibt.fOptions
[in] Flags für Befehle (siehe Abschnitt“ PopulateList-Flags „ Bitflags, die von bestimmten Befehlen verwendet werden für Details).
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 |
Erfolgreich. |
SCC_E_NONSPECIFICERROR |
Unspezifischer Fehler. |
Hinweise
Diese Funktion aktiviert die Liste der Dateien für den aktuellen Status. Es wird die pfnPopulate Rückruffunktion, um den Aufrufer benachrichtigt, wenn eine Datei nicht den Kriterien für nCommandübereinstimmt. Wenn beispielsweise der Befehl SCC_COMMAND_CHECKIN ist und eine Datei in der Liste nicht ausgecheckt ist, wird der Rückruf wird verwendet, um dem Aufrufer mitzuteilen. Gelegentlich sucht das Quellcodeverwaltungs-Plug-In möglicherweise weitere Dateien, die Teil des Befehls sein, und sie hinzufügen können. Dies bietet, z. B. ein Benutzer von Visual Basic können Sie eine BMP-Datei auszuchecken, der durch seinen oder Projekt verwendet wird, aber nicht in der Visual Basic-Projekt-Datei angezeigt wird. Ein Benutzer wählt den Abrufen Befehl in der IDE aus. Die IDE zeigt eine Liste aller Dateien an, dass es denkt, der Benutzer abrufen kann, aber bevor die Liste angezeigt wird, die SccPopulateList-Funktion aufgerufen wird, um sicherzustellen, dass die anzuzeigende Liste auf dem neuesten Stand ist.
Beispiel
Die IDE erstellt eine Liste der Dateien, die sie denkt, dass der Benutzer abrufen kann. Bevor diese Liste angezeigt wird, ruft es die SccPopulateList-Funktion auf und gibt das Quellcodeverwaltungs-Plug-In die Möglichkeit, Dateien aus der Liste hinzuzufügen und zu löschen. Das Plug-In wird die Liste, indem die angegebene Rückruffunktion aufgerufen wird (siehe POPLISTFUNC für weitere Details).
Das Plug-In wird fortgesetzt, um die pfnPopulate-Funktion aufrufen, die Dateien hinzugefügt und gelöscht wird, bis er beendet und dann von der SccPopulateList-Funktion einen Wert zurückgibt. Die IDE kann dann die Liste anzeigen. Das lpStatus Array stellt alle Dateien in der ursprünglichen Liste dar, die durch die IDE übergeben wird. Das Plug-In füllt den Status aller dieser Dateien zusätzlich zum Ausnutzen der Rückruffunktion ausgeführt.
Hinweis
Ein Quellcodeverwaltungs-Plug-In hat immer die Möglichkeit, sofort problemlos von dieser Funktion zurückgegeben wird und belässt die Liste, während sie ist.Wenn ein Plug-In diese Funktion implementiert, kann dies angeben, indem Sie das SCC_CAP_POPULATELIST-Funktion bitflag im ersten Aufruf von SccInitialize-Funktionfestlegt.Standardmäßig sollte das Plug-In immer davon ausgehen, dass alle Elemente, die übergeben werden, sind Dateien.Wenn die IDE das SCC_PL_DIR-Flag im fOptions-Parameter festgelegt wird, werden alle Elemente, die übergeben werden, gelten als Verzeichnisse.Das Plug-In sollte alle Dateien hinzufügen, die in den Verzeichnissen gehören.Die IDE gilt nicht für eine Mischung von Dateien und Verzeichnissen.