Freigeben über


POPLISTFUNC

Dieser Rückruf wird von der IDE an die SccPopulateList übergeben und vom Quellcodeverwaltungs-Plug-In verwendet, um eine Liste von Dateien oder Verzeichnissen zu aktualisieren (auch für die SccPopulateList Funktion bereitgestellt).

Wenn ein Benutzer den Befehl "Abrufen " in der IDE auswäht, zeigt die IDE ein Listenfeld aller Dateien an, die der Benutzer abrufen kann. Leider kennt die IDE nicht die genaue Liste aller Dateien, die der Benutzer erhalten kann; nur das Plug-In hat diese Liste. Wenn andere Benutzer dem Quellcodeverwaltungsprojekt Dateien hinzugefügt haben, sollten diese Dateien in der Liste angezeigt werden, aber die IDE kennt sie nicht. Die IDE erstellt eine Liste der Dateien, die der Benutzer abrufen kann. Bevor sie diese Liste für den Benutzer anzeigt, ruft sie die SccPopulateList, auf, sodass das Quellcodeverwaltungs-Plug-In die Möglichkeit erhält, Dateien aus der Liste hinzuzufügen und zu löschen.

Signature

Das Quellcodeverwaltungs-Plug-In ändert die Liste durch Aufrufen einer IDE-implementierten Funktion mit dem folgenden Prototyp:

typedef BOOL (*POPLISTFUNC) (
   LPVOID pvCallerData,
   BOOL fAddRemove,
   LONG nStatus,
   LPSTR lpFileName
);

Parameter

pvCallerData Der pvCallerData Parameter, der vom Aufrufer (der IDE) an die SccPopulateList übergeben wird. Das Quellcodeverwaltungs-Plug-In sollte nichts über den Inhalt dieses Parameters annehmen.

"fAddRemove If TRUE" lpFileName ist eine Datei, die der Dateiliste hinzugefügt werden soll. Wenn FALSEes sich um eine Datei handelt, lpFileName die aus der Dateiliste gelöscht werden soll.

nStatus-Status von lpFileName (eine Kombination der SCC_STATUS Bits; weitere Informationen finden Sie im Dateistatuscode ).

lpFileName Vollständiger Verzeichnispfad des Dateinamens, der aus der Liste hinzugefügt oder gelöscht werden soll.

Rückgabewert

Wert Beschreibung
TRUE Das Plug-In kann den Aufruf dieser Funktion fortsetzen.
FALSE Auf der IDE-Seite ist ein Problem aufgetreten (z. B. eine Nichtspeichersituation). Das Plug-In sollte den Vorgang beenden.

Hinweise

Für jede Datei, die das Quellcodeverwaltungs-Plug-In aus der Dateiliste hinzufügen oder löschen möchte, ruft sie diese Funktion auf und übergibt die lpFileName. Das fAddRemove Flag gibt eine neue Datei an, die der Liste oder einer alten zu löschenden Datei hinzugefügt werden soll. Der nStatus Parameter gibt den Status der Datei an. Wenn das SCC-Plug-In das Hinzufügen und Löschen von Dateien abgeschlossen ist, wird es aus dem SccPopulateList-Aufruf zurückgegeben.

Hinweis

Das SCC_CAP_POPULATELIST Funktionsbit ist für Visual Studio erforderlich.

Siehe auch