Funkcja SccGetEvents
Ta funkcja pobiera zdarzenie stanu w kolejce.
Składnia
SCCRTN SccGetEvents (
LPVOID pvContext,
LPSTR lpFileName,
LPLONG lpStatus,
LPLONG pnEventsRemaining
);
Parametry
pvContext
[in] Struktura kontekstu wtyczki kontroli źródła.
lpFileName
[in, out] Bufor, w którym wtyczka kontroli źródła umieszcza zwracaną nazwę pliku (do _MAX_PATH znaków).
lpStatus
[in, out] Zwraca kod stanu (zobacz Kod stanu pliku, aby uzyskać możliwe wartości).
pnEventsRemaining
[in, out] Zwraca liczbę wpisów pozostawionych w kolejce po tym wywołaniu. Jeśli ten numer jest duży, obiekt wywołujący może zdecydować się na wywołanie SccQueryInfo w celu uzyskania wszystkich informacji jednocześnie.
Wartość zwracana
Implementacja wtyczki kontroli źródła tej funkcji powinna zwrócić jedną z następujących wartości:
| Wartość | Opis |
|---|---|
| SCC_OK | Pobieranie zdarzeń powiodło się. |
| SCC_E_OPNOTSUPPORTED | Ta funkcja nie jest obsługiwana. |
| SCC_E_NONSPECIFICERROR | Niepowodzeń nieokreślonych. |
Uwagi
Ta funkcja jest wywoływana podczas przetwarzania bezczynności, aby sprawdzić, czy istnieją jakiekolwiek aktualizacje stanu plików pod kontrolą źródła. Wtyczka kontroli źródła zachowuje stan wszystkich plików, o których wie, i za każdym razem, gdy zmiana stanu jest zanotowana przez wtyczkę, stan i skojarzony plik są przechowywane w kolejce. Po SccGetEvents wywołaniu zostanie pobrany i zwrócony górny element kolejki. Ta funkcja jest ograniczona do zwracania tylko wcześniej buforowanych informacji i musi mieć bardzo szybki zwrot (czyli brak odczytu dysku lub monitowanie systemu kontroli źródła o stan); w przeciwnym razie wydajność środowiska IDE może zacząć się obniżać.
Jeśli nie ma aktualizacji stanu do raportowania, wtyczka kontroli źródła przechowuje pusty ciąg w buforze wskazywanym przez .lpFileName W przeciwnym razie wtyczka przechowuje pełną nazwę ścieżki pliku, dla którego zmieniono informacje o stanie i zwraca odpowiedni kod stanu (jedną z wartości opisanych w kodzie stanu pliku).