SccHistory – funkce

  • Článek

Tato funkce zobrazí historii zadaných souborů.

Syntaxe

SCCRTN SccHistory(
   LPVOID    pvContext,
   HWND      hWnd,
   LONG      nFiles,
   LPCSTR*   lpFileNames,
   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.

nFiles

[v] Počet souborů zadaných lpFileName v poli

lpFileName

[v] Pole plně kvalifikovaných názvů souborů

fOptions

[v] Příznaky příkazů (aktuálně se nepoužívají).

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 Historie verzí byla úspěšně získána.
SCC_I_RELOADFILE Systém správy zdrojového kódu skutečně upravil soubor na disku při načítání historie (například získáním staré verze), takže integrované vývojové prostředí (IDE) by mělo tento soubor znovu načíst.
SCC_E_FILENOTCONTROLLED Soubor není pod správou zdrojového kódu.
SCC_E_OPNOTSUPPORTED Systém správy zdrojového kódu tuto operaci nepodporuje.
SCC_E_NOTAUTHORIZED Uživatel nemůže tuto operaci provést.
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_PROJNOTOPEN Projekt nebyl otevřen.
SCC_E_NONSPECIFICERROR Nespecifické selhání. Nelze získat historii souborů.

Poznámky

Modul plug-in správy zdrojového kódu může zobrazit vlastní dialogové okno pro zobrazení historie jednotlivých souborů, které se používají hWnd jako nadřazené okno. Případně lze použít volitelnou funkci zpětného volání výstupu textu zadanou do projektu SccOpenProject , pokud je podporována.

Všimněte si, že za určitých okolností se může soubor, který je zkoumán, během provádění tohoto volání změnit. Například příkaz Historie vizuálu Sejf dává uživateli možnost získat starou verzi souboru. V takovém případě modul plug-in správy zdrojového kódu vrátí SCC_I_RELOAD upozornění integrovaného vývojového prostředí (IDE), že soubor musí znovu načíst.

Poznámka:

Pokud modul plug-in správy zdrojového kódu nepodporuje tuto funkci pro pole souborů, lze zobrazit pouze historii souborů pro první soubor.

Viz také