SccPopulateList – funkce

Článek
10/10/2023

Tato funkce aktualizuje seznam souborů pro konkrétní příkaz správy zdrojového kódu a poskytuje stav správy zdrojového kódu pro všechny dané soubory.

Syntaxe

SCCRTN SccPopulateList (
   LPVOID          pvContext,
   enum SCCCOMMAND nCommand,
   LONG            nFiles,
   LPCSTR*         lpFileNames,
   POPLISTFUNC     pfnPopulate,
   LPVOID          pvCallerData,
   LPLONG          lpStatus,
   LONG            fOptions
);

Parametry

pvContext

[v] Kontextová struktura modulu plug-in správy zdrojového kódu.

nCommand

[v] Příkaz správy zdrojového kódu, který se použije pro všechny soubory v lpFileNames poli (viz Příkazový kód pro seznam možných příkazů).

nSoubory

[v] Počet souborů v lpFileNames poli

lpFileNames

[v] Pole názvů souborů známých integrovanému vývojovému prostředí (IDE)

pfnPopulate

[v] Funkce zpětného volání integrovaného vývojového prostředí pro volání pro přidání a odebrání souborů (podrobnosti najdete v tématu POPLISTFUNC ).

pvCallerData

[v] Hodnota, která se má předat beze změny funkci zpětného volání.

lpStatus

[in, out] Pole modulu plug-in správy zdrojového kódu pro vrácení stavových příznaků pro každý soubor.

FOptions

[v] Příznaky příkazů (podrobnosti najdete v části Příznak PopulateList v části Bitflags Používané konkrétními příkazy ).

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	Úspěch
SCC_E_NONSPECIFICERROR	Nespecifické selhání.

Poznámky

Tato funkce prozkoumá seznam souborů pro aktuální stav. Pomocí funkce zpětného pfnPopulate volání upozorní volajícího, když soubor neodpovídá kritériím pro .nCommand Pokud je SCC_COMMAND_CHECKIN příkaz a soubor v seznamu není rezervován, použije se zpětné volání k informování volajícího. Někdy může modul plug-in správy zdrojového kódu najít další soubory, které můžou být součástí příkazu, a přidat je. To například umožňuje uživateli jazyka Visual Basic rezervovat soubor .bmp, který používá jeho projekt, ale nezobrazuje se v souboru projektu jazyka Visual Basic. Uživatel zvolí příkaz Get v integrovaném vývojovém prostředí (IDE). Integrované vývojové prostředí zobrazí seznam všech souborů, které si myslí, že uživatel může získat, ale před zobrazením seznamu se volá funkce, aby se zajistilo, SccPopulateList že seznam, který se má zobrazit, je aktuální.

Příklad

Integrované vývojové prostředí vytvoří seznam souborů, které si myslí, že uživatel může získat. Než tento seznam zobrazí, zavolá SccPopulateList funkci a poskytne modulu plug-in správy zdrojového kódu možnost přidávat a odstraňovat soubory ze seznamu. Modul plug-in upraví seznam voláním dané funkce zpětného volání (další podrobnosti najdete v tématu POPLISTFUNC ).

Modul plug-in bude dál volat pfnPopulate funkci, která přidává a odstraňuje soubory, dokud se nedokončí a pak se vrátí z SccPopulateList funkce. Integrované vývojové prostředí (IDE) pak může zobrazit jeho seznam. Pole lpStatus představuje všechny soubory v původním seznamu předané integrovaném vývojovém prostředí (IDE). Modul plug-in vyplní stav všech těchto souborů kromě použití funkce zpětného volání.

Poznámka:

Modul plug-in správy zdrojového kódu má vždy možnost jednoduše vrátit okamžitě z této funkce a ponechat seznam tak, jak je. Pokud modul plug-in implementuje tuto funkci, může to znamenat nastavením SCC_CAP_POPULATELIST bitflag schopnosti v prvním volání SccInitialize. Ve výchozím nastavení by modul plug-in měl vždy předpokládat, že všechny předané položky jsou soubory. Pokud však integrované vývojové prostředí nastaví SCC_PL_DIR příznak v parametru fOptions , budou se všechny předané položky považovat za adresáře. Modul plug-in by měl přidat všechny soubory, které patří do adresářů. Integrované vývojové prostředí (IDE) nikdy nepředá kombinaci souborů a adresářů.

Sdílet prostřednictvím