SccCheckout – funkce
Vzhledem k seznamu plně kvalifikovaných názvů souborů je tato funkce zkontroluje na místní jednotce. Komentář platí pro všechny rezervované soubory. Argument komentáře může být null
řetězec.
Syntaxe
SCCRTN SccCheckout (
LPVOID pvContext,
HWND hWnd,
LONG nFiles,
LPCSTR* lpFileNames,
LPCSTR lpComment,
LONG fOptions,
LPCMDOPTS pvOptions
);
Parametry
pvContext
[v] Kontextová struktura modulu plug-in správy zdrojového kódu.
Hwnd
[v] Popisovač okna integrovaného vývojového prostředí(IDE), které modul plug-in správy zdrojového kódu může použít jako nadřazený prvek pro všechna dialogová okna, která poskytuje.
nSoubory
[v] Počet vybraných souborů, které mají být rezervovány
lpFileNames
[v] Pole plně kvalifikovaných názvů místních cest k souborům, které se mají rezervovat.
lpComment
[v] Komentář, který se má použít pro každý z vybraných souborů, které jsou rezervovány.
FOptions
[v] Příznaky příkazů (viz Bitflags používané konkrétními příkazy).
pvOptions
[v] Možnosti modulu plug-in správy zdrojového kódu
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 | Rezervace byla úspěšná. |
SCC_E_FILENOTCONTROLLED | Vybraný soubor není pod správou zdrojového kódu. |
SCC_E_ACCESSFAILURE | Při přístupu k systému správy zdrojového kódu došlo k potížím, pravděpodobně kvůli problémům se sítí nebo kolizí. Doporučuje se opakování. |
SCC_E_NOTAUTHORIZED | Uživatel nemůže tuto operaci provést. |
SCC_E_NONSPECIFICERROR | Nespecifické selhání. Soubor nebyl rezervován. |
SCC_E_ALREADYCHECKEDOUT | Uživatel už soubor rezervoval. |
SCC_E_FILEISLOCKED | Soubor je uzamčen a zakazuje vytváření nových verzí. |
SCC_E_FILEOUTEXCLUSIVE | Jiný uživatel provedl výhradní rezervaci tohoto souboru. |
SCC_I_OPERATIONCANCELED | Operace byla zrušena před dokončením. |