SccGetEvents – funkce
Tato funkce načte událost stavu ve frontě.
Syntaxe
SCCRTN SccGetEvents (
LPVOID pvContext,
LPSTR lpFileName,
LPLONG lpStatus,
LPLONG pnEventsRemaining
);
Parametry
pvContext
[v] Kontextová struktura modulu plug-in správy zdrojového kódu.
lpFileName
[in, out] Vyrovnávací paměť, ve které modul plug-in správy zdrojového kódu umístí vrácený název souboru (až _MAX_PATH znaků).
lpStatus
[in, out] Vrátí stavový kód (viz stavový kód souboru pro možné hodnoty).
pnEventsRemaining
[in, out] Vrátí počet položek, které zůstaly ve frontě po tomto volání. Pokud je toto číslo velké, volající se může rozhodnout volat SccQueryInfo , aby získal všechny informace najednou.
Vrácená hodnota
Očekává se, že implementace modulu plug-in správy zdrojového kódu této funkce vrátí jednu z následujících hodnot:
| Hodnota | Popis |
|---|---|
| SCC_OK | Získání úspěšných událostí |
| SCC_E_OPNOTSUPPORTED | Tato funkce není podporována. |
| SCC_E_NONSPECIFICERROR | Nespecifické selhání. |
Poznámky
Tato funkce se volá během zpracování nečinnosti a zjistí, jestli nedošlo k nějakým aktualizacím stavu pro soubory ve správě zdrojového kódu. Modul plug-in správy zdrojového kódu udržuje stav všech souborů, o které ví, a pokaždé, když modul plug-in zaznačí změnu stavu, stav a přidružený soubor se uloží do fronty. Při SccGetEvents zavolání se načte a vrátí horní prvek fronty. Tato funkce je omezena tak, aby vracela pouze dříve uložené informace v mezipaměti a musí mít velmi rychlý návrat (to znamená, že čtení disku nebo dotazování systému správy zdrojového kódu o stav); jinak může dojít ke snížení výkonu integrovaného vývojového prostředí (IDE).
Pokud neexistuje žádná aktualizace stavu pro sestavu, modul plug-in správy zdrojového kódu uloží prázdný řetězec do vyrovnávací paměti, na kterou lpFileNameodkazuje . V opačném případě modul plug-in ukládá úplný název cesty k souboru, pro který se změnily informace o stavu, a vrátí odpovídající stavový kód (jedna z hodnot podrobně popsaných ve stavovém kódu souboru).