SccRename – funkce

  • Článek

Tato funkce přejmenuje soubor v systému správy zdrojového kódu.

Syntaxe

SCCRTN SccRename(
   LPVOID pvContext,
   HWND   hWnd,
   LPCSTR lpFileName,
   LPCSTR lpNewName
);

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.

lpFileName

[v] Plně kvalifikovaný název souboru, který se přejmenovává.

lpNewName

[v] Plně kvalifikovaný nový název. Pokud se cesta k adresáři liší, soubor se přesunul z jednoho podadresáře do jiného.

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 Operace přejmenování byla úspěšně dokončena.
SCC_E_PROJNOTOPEN Projekt není v rámci správy zdrojového kódu otevřený.
SCC_E_FILENOTCONTROLLED 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í.
SCC_E_NOTAUTHORIZED Uživatel nemá oprávnění k dokončení této operace.
SCC_E_COULDNOTCREATEPROJECT Projekt nelze vytvořit jako součást procesu přejmenování.
SCC_E_OPNOTPERFORMED Operace nebyla provedena.
SCC_E_NONSPECIFICERROR Došlo k nezadané nebo obecné chybě.

Poznámky

Tuto funkci lze použít k přejmenování souboru nebo jeho přesunutí z jednoho umístění do jiného v systému správy zdrojového kódu. Modul plug-in správy zdrojového kódu by se neměl pokoušet o přístup k souboru na disku. Je zodpovědností integrovaného vývojového prostředí přejmenovat místní soubor.

Viz také