Funkce modulu plug-in správy zdrojového kódu v rozhraní API
Modul plug-in správy zdrojového kódu poskytuje následující funkce, které musí modul plug-in správy zdrojového kódu implementovat v souladu s tímto rozhraním API. Podpisy jednotlivých funkcí a sémantiky spojené s bitovými příznaky a další parametry jsou podrobně popsány v tomto odkazu.
Inicializace a funkce úklidu
| Function | Popis |
|---|---|
| SccCloseProject | Zavře projekt. |
| SccGetCommandOptions | Vyzve uživatele k zadání upřesňujících možností pro daný příkaz. |
| SccGetVersion | Vrátí verzi modulu plug-in správy zdrojového kódu. |
| SccInitialize | Inicializuje modul plug-in správy zdrojového kódu. Volá se jednou pro každou instanci modulu plug-in. |
| SccOpenProject | Otevře projekt. |
| SccSetOption | Obecná funkce používaná k nastavení široké škály možností. Každá možnost začíná SCC_OPT_xxx a má svou vlastní definovanou sadu hodnot. |
| SccUninitialize | Volá se jednou, když je potřeba modul plug-in správy zdrojového kódu odpojit. |
Základní funkce správy zdrojového kódu
| Function | Popis |
|---|---|
| SccAdd | Přidá do systému správy zdrojového kódu pole souborů určených plně kvalifikovanými názvy cest. |
| SccAddFromScc | Umožňuje uživateli vyhledat soubory, které už jsou v systému správy zdrojového kódu, a pak tyto soubory nastavit jako součást aktuálního projektu. |
| SccCheckin | Kontroluje pole souborů. |
| SccCheckout | Zkontroluje pole souborů. |
| SccDiff | Zobrazuje rozdíly mezi souborem místního uživatele určeným plně kvalifikovaným názvem cesty a verzí ve správě zdrojového kódu. |
| SccGet | Načte kopii sady souborů jen pro čtení. |
| SccGetEvents | Zkontroluje stav souborů, o které volající požádal (prostřednictvím SccQueryInfo). |
| SccGetProjPath | Způsobí, že modul plug-in správy zdrojového kódu vyzve uživatele k zadání cesty projektu, která je pro modul plug-in smysluplná. |
| SccHistory | Zobrazuje historii pole plně kvalifikovaných názvů místních souborů. |
| SccPopulateList | Zkontroluje seznam souborů pro jejich aktuální stav. Kromě toho pomocí pfnPopulate funkce upozorňovat volajícího, když soubor neodpovídá kritériím pro .nCommand |
| SccProperties | Zobrazuje vlastnosti plně kvalifikovaného souboru. |
| SccQueryInfo | Zkontroluje seznam plně kvalifikovaných souborů pro jejich aktuální stav. |
| SccRemove | Odebere pole plně kvalifikovaných souborů ze systému správy zdrojového kódu. |
| SccRename | Přejmenuje daný soubor na nový název v systému správy zdrojového kódu. |
| SccRunScc | Přistupuje k celé řadě funkcí systému správy zdrojového kódu. |
| SccUncheckout | Vrátí rezervaci pole souborů. |
Funkce, které podporují další funkce (verze 1.2 rozhraní API modulu plug-in správy zdrojového kódu)
Tato skupina funkcí definuje další funkce zahrnuté ve verzi 1.2 rozhraní API modulu plug-in správy zdrojového kódu. Poskytují přístup k pokročilejším funkcím a možnostem správy zdrojového kódu.
| Function | Popis |
|---|---|
| SccBeginBatch | Spustí dávkovou operaci. |
| SccCreateSubProject | Vytvoří dílčí projekt s daným názvem pod existujícím nadřazeným projektem. |
| SccDirDiff | Zobrazuje rozdíly mezi adresářem místního uživatele určeným plně kvalifikovaným názvem cesty a umístěním databáze správy zdrojového kódu. |
| SccDirQueryInfo | Zkontroluje seznam plně kvalifikovaných adresářů pro jejich aktuální stav. |
| SccEndBatch | Ukončí dávkovou operaci. |
| SccGetParentProjectPath | Vrátí nadřazenou cestu daného projektu (projekt musí existovat). |
| SccIsMultiCheckoutEnabled | Zkontroluje, jestli je povolené více rezervaci v souboru. |
| SccWillCreateSccFile | Zkontroluje, jestli modul plug-in vytvoří MSSCCPRJ. Soubory SCC. |
Funkce, které podporují pokročilé funkce (verze 1.3 rozhraní API modulu plug-in správy zdrojového kódu)
Tato skupina funkcí definuje další funkce zahrnuté ve verzi 1.3 rozhraní API modulu plug-in správy zdrojového kódu. Poskytují přístup k pokročilejším funkcím a možnostem správy zdrojového kódu.
| Function | Popis |
|---|---|
| SccAddFilesFromSCC | Přidá do aktuálního projektu seznam souborů ze správy zdrojového kódu. |
| SccBackgroundGet | Načte seznam souborů ze správy zdrojového kódu bez uživatelského rozhraní. |
| SccEnumChangedFiles | Načte seznam souborů ve správě zdrojového kódu, které se liší od místních souborů. |
| SccGetExtendedCapabilities | Načte příznaky, které určují rozšířené možnosti podporované modulem plug-in správy zdrojového kódu. |
| SccGetUserOption | Načte možnosti specifické pro uživatele. |
| SccPopulateDirList | Prozkoumá seznam adresářů a souborů v projektu nebo projektech, které jsou pod správou zdrojového kódu. Každý nalezený adresář a název souboru se předá funkci zpětného volání. |
| SccQueryChanges | Zkontroluje změny názvů provedené v seznamu souborů. Každý název souboru se předává funkci zpětného volání se stavem změny. |
Požadavky
Hlavička: scc.h
(Ve výchozím nastavení je součástí sady SDK prostředí společná složka.[jednotka]\Program Files\VSIP 8.0\EnvSDK\common\inc; součástí složky VSIP s ukázkou MSSCCI, [jednotka]\Program Files\VSIP 8.0\MSSCCI).