POPLISTFUNC
To wywołanie zwrotne jest dostarczane do listy SccPopulateList przez środowisko IDE i jest używane przez wtyczkę kontroli źródła w celu zaktualizowania listy plików lub katalogów (również dostarczonych do SccPopulateList funkcji).
Gdy użytkownik wybierze polecenie Pobierz w środowisku IDE, w środowisku IDE zostanie wyświetlone pole listy wszystkich plików, które użytkownik może uzyskać. Niestety środowisko IDE nie zna dokładnej listy wszystkich plików, które użytkownik może uzyskać; tylko wtyczka ma tę listę. Jeśli inni użytkownicy dodali pliki do projektu kontroli kodu źródłowego, te pliki powinny pojawić się na liście, ale środowisko IDE nie wie o nich. Środowisko IDE tworzy listę plików, które uważa, że użytkownik może uzyskać. Przed wyświetleniem tej listy użytkownikowi wywołuje ona wtyczkę SccPopulateList, , co daje wtyczki kontroli źródła szansę dodawania i usuwania plików z listy.
Podpis
Wtyczka kontroli źródła modyfikuje listę, wywołując funkcję zaimplementowaną przez środowisko IDE z następującym prototypem:
typedef BOOL (*POPLISTFUNC) (
LPVOID pvCallerData,
BOOL fAddRemove,
LONG nStatus,
LPSTR lpFileName
);
Parametry
pvCallerData Parametr pvCallerData przekazany przez obiekt wywołujący (IDE) do listy SccPopulateList. Wtyczka kontroli źródła nie powinna zakładać nic o zawartości tego parametru.
fAddRemove If TRUElpFileName to plik, który powinien zostać dodany do listy plików. Jeśli FALSEelement lpFileName to plik, który powinien zostać usunięty z listy plików.
nStatus Status ( lpFileName kombinacja SCC_STATUS bitów; zobacz Kod stanu pliku, aby uzyskać szczegółowe informacje).
lpFileName Pełna ścieżka katalogu nazwy pliku do dodania lub usunięcia z listy.
Wartość zwracana
| Wartość | Opis |
|---|---|
TRUE |
Wtyczka może kontynuować wywoływanie tej funkcji. |
FALSE |
Wystąpił problem po stronie środowiska IDE (na przykład sytuacja braku pamięci). Wtyczka powinna zatrzymać działanie. |
Uwagi
Dla każdego pliku, który wtyczka kontroli źródła chce dodać lub usunąć z listy plików, wywołuje tę funkcję, przekazując lpFileNameelement . Flaga fAddRemove wskazuje nowy plik do dodania do listy lub starego pliku do usunięcia. Parametr nStatus określa stan pliku. Po zakończeniu dodawania i usuwania plików wtyczka SCC powraca z wywołania SccPopulateList .
Uwaga
Bit SCC_CAP_POPULATELIST możliwości jest wymagany dla programu Visual Studio.