SccSetOption – funkce
Tato funkce nastavuje možnosti, které řídí chování modulu plug-in správy zdrojového kódu.
Syntaxe
SCCRTN SccSetOption(
LPVOID pvContext,
LONG nOption,
LONG dwVal
);
Parametry
pvContext
[v] Kontextová struktura modulu plug-in správy zdrojového kódu.
nOption
[v] Možnost, která se nastavuje.
dwVal
[v] Nastavení pro možnost.
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 | Možnost byla úspěšně nastavena. |
| SCC_I_SHARESUBPROJOK | Vráceno, pokud nOption byl SCC_OPT_SHARESUBPROJ a modul plug-in správy zdrojového kódu umožňuje integrovanému vývojovému prostředí (IDE) nastavit cílovou složku. |
| SCC_E_OPNOTSUPPORTED | Možnost nebyla nastavena a neměla by se spoléhat. |
Poznámky
Integrované vývojové prostředí (IDE) volá tuto funkci, která řídí chování modulu plug-in správy zdrojového kódu. První parametr , nOptionoznačuje hodnotu, která je nastavena, zatímco druhá, dwValoznačuje, co dělat s danou hodnotou. Modul plug-in ukládá tyto informace přidružené k integrovanému vývojovému pvContext``, prostředí (IDE) musí tuto funkci volat po volání SccInitialize (ale ne nutně po každém volání SccOpenProject).
Souhrn možností a jejich hodnot:
nOption |
dwValue |
Popis |
|---|---|---|
SCC_OPT_EVENTQUEUE |
SCC_OPT_EQ_DISABLESCC_OPT_EQ_ENABLE |
Povolí nebo zakáže řízení front událostí na pozadí. |
SCC_OPT_USERDATA |
Libovolná hodnota | Určuje hodnotu uživatele, která se má předat funkci zpětného volání OPTNAMECHANGEPFN . |
SCC_OPT_HASCANCELMODE |
SCC_OPT_HCM_NOSCC_OPT_HCM_YES |
Určuje, jestli integrované vývojové prostředí (IDE) aktuálně podporuje zrušení operace. |
SCC_OPT_NAMECHANGEPFN |
Ukazatel na funkci ZPĚTNÉho volání OPTNAMECHANGEPFN | Nastaví ukazatel na funkci zpětného volání změny názvu. |
SCC_OPT_SCCCHECKOUTONLY |
SCC_OPT_SCO_NOSCC_OPT_SCO_YES |
Určuje, jestli integrované vývojové prostředí (IDE) umožňuje ruční rezervaci souborů (prostřednictvím uživatelského rozhraní správy zdrojového kódu) nebo jestli je nutné je rezervovat pouze prostřednictvím modulu plug-in správy zdrojového kódu. |
SCC_OPT_SHARESUBPROJ |
– | Pokud modul plug-in správy zdrojového kódu umožňuje integrovanému vývojovému prostředí určit místní složku projektu, modul plug-in vrátí SCC_I_SHARESUBPROJOK. |
SCC_OPT_EVENTQUEUE
Pokud nOption ano, integrované vývojové prostředí SCC_OPT_EVENTQUEUE(IDE) zakáže (nebo znovu povolí) zpracování na pozadí. Například během kompilace může integrované vývojové prostředí (IDE) instruovat modul plug-in správy zdrojového kódu, aby zastavil zpracování jakéhokoliv druhu nečinnosti. Po kompilaci by znovu povolil zpracování na pozadí, aby fronta událostí modulu plug-in byla aktuální. Odpovídající hodnotě SCC_OPT_EVENTQUEUEnOption, existují dvě možné hodnoty pro dwVal, konkrétně SCC_OPT_EQ_ENABLE , a SCC_OPT_EQ_DISABLE.
SCC_OPT_HASCANCELMODE
Pokud je SCC_OPT_HASCANCELMODEhodnota, nOption integrované vývojové prostředí (IDE) umožňuje uživatelům zrušit dlouhé operace. Nastavení na SCC_OPT_HCM_NO (výchozí) označuje, že integrované vývojové prostředí dwVal nemá žádný režim zrušení. Modul plug-in správy zdrojového kódu musí nabízet vlastní tlačítko Zrušit, pokud chce, aby uživatel mohl zrušit. SCC_OPT_HCM_YES označuje, že integrované vývojové prostředí (IDE) poskytuje možnost zrušit operaci, takže modul plug-in SCC nemusí zobrazovat vlastní tlačítko Zrušit. Pokud se integrované vývojové prostředí nastaví dwVal na SCC_OPT_HCM_YES, je připravené reagovat na SCC_MSG_STATUS funkci zpětného volání a DOCANCEL zprávy odeslané do funkce zpětného lpTextOutProc volání (viz LPTEXTOUTPROC). Pokud integrované vývojové prostředí nenastaví tuto proměnnou, modul plug-in by neměl tyto dvě zprávy odesílat.
SCC_OPT_NAMECHANGEPFN
Pokud je nOption nastavena na SCC_OPT_NAMECHANGEPFNa jak modul plug-in správy zdrojového kódu, tak integrované vývojové prostředí (IDE) ho umožňují, modul plug-in může soubor během operace správy zdrojového kódu skutečně přejmenovat nebo přesunout. Nastaví dwVal se na ukazatel funkce typu OPTNAMECHANGEPFN. Během operace správy zdrojového kódu může modul plug-in tuto funkci volat a předat tři parametry. Jedná se o starý název souboru (s plně kvalifikovanou cestou), nový název (s plně kvalifikovanou cestou) tohoto souboru a ukazatel na informace, které mají význam pro integrované vývojové prostředí (IDE). Integrované vývojové prostředí (IDE) odesílá v tomto posledním ukazateli voláním SccSetOption nastaveným nOption na SCC_OPT_USERDATA, a dwVal odkazováním na data. Podpora této funkce je volitelná. Modul plug-in VSSCI, který tuto schopnost používá, musí inicializovat ukazatel funkce a proměnné uživatelských dat do NULLa nesmí volat funkci přejmenování, pokud nebyla zadána. Měla by být také připravena uchovávat hodnotu, kterou byla předána, nebo ji změnit v reakci na nové volání SccSetOption. K tomu nedojde uprostřed operace příkazu správy zdrojového kódu, ale může k tomu dojít mezi příkazy.
SCC_OPT_SCCCHECKOUTONLY
Pokud je nOption nastaven na SCC_OPT_SCCCHECKOUTONLY, integrované vývojové prostředí indikuje, že soubory v aktuálně otevřeném projektu by nikdy neměly být rezervovány ručně prostřednictvím uživatelského rozhraní systému správy zdrojového kódu. Místo toho by se soubory měly rezervovat pouze prostřednictvím modulu plug-in správy zdrojového kódu v rámci ovládacího prvku IDE. Pokud dwValue je nastavená hodnota SCC_OPT_SCO_NO, znamená to, že soubory by měly být zacházeno normálně modulem plug-in a lze je rezervovat prostřednictvím uživatelského rozhraní správy zdrojového kódu. Pokud dwValue je nastavená hodnota SCC_OPT_SCO_YES, pak je povolena pouze modul plug-in rezervovat soubory a uživatelské rozhraní systému správy zdrojového kódu by nemělo být vyvoláno. To je v situacích, kdy integrované vývojové prostředí (IDE) může mít pseudosouhlasy, které mají smysl rezervovat pouze prostřednictvím integrovaného vývojového prostředí (IDE).
SCC_OPT_SHARESUBPROJ
PokudnOption je nastavené SCC_OPT_SHARESUBPROJ, integrované vývojové prostředí testuje, jestli modul plug-in správy zdrojového kódu může při přidávání souborů ze správy zdrojového kódu použít zadanou místní složku. Hodnota parametru dwVal v tomto případě nezáleží. Pokud modul plug-in umožňuje integrovanému vývojovému prostředí (IDE) určit místní cílovou složku, do které se při zavolání SccAddFromScc přidají soubory ze správy zdrojového kódu, musí modul plug-in při zavolání funkce vrátit SCC_I_SHARESUBPROJOKSccSetOption. Integrované vývojové prostředí pak použije lplpFileNames parametr SccAddFromScc funkce k předání cílové složky. Modul plug-in používá cílovou složku k umístění souborů přidaných ze správy zdrojového kódu. Pokud modul plug-in po nastavení možnosti nevrátí SCC_I_SHARESUBPROJOKSCC_OPT_SHARESUBPROJ , integrované vývojové prostředí předpokládá, že modul plug-in dokáže přidat soubory pouze do aktuální místní složky.