SccRename-Funktion
Diese Funktion benennt eine Datei im Quellcodeverwaltungssystem um.
Syntax
SCCRTN SccRename(
LPVOID pvContext,
HWND hWnd,
LPCSTR lpFileName,
LPCSTR lpNewName
);
Parameter
pvContext
[in] Die Kontextstruktur des Quellcodeverwaltungs-Plug-Ins.
hWnd
[in] Ein Handle für das IDE-Fenster, das das Quellcodeverwaltungs-Plug-In als übergeordnetes Element für alle von ihr bereitgestellten Dialogfelder verwenden kann.
lpFileName
[in] Der vollqualifizierte Dateiname der umbenannten Datei.
lpNewName
[in] Der vollqualifizierte neue Name. Wenn der Verzeichnispfad anders ist, wurde die Datei von einem Unterverzeichnis in ein anderes verschoben.
Rückgabewert
Die Plug-In-Implementierung dieser Funktion für die Quellcodeverwaltung wird voraussichtlich einen der folgenden Werte zurückgeben:
| Wert | Beschreibung |
|---|---|
| SCC_OK | Der Umbenennungsvorgang wurde erfolgreich abgeschlossen. |
| SCC_E_PROJNOTOPEN | Das Projekt ist nicht unter Quellcodeverwaltung geöffnet. |
| SCC_E_FILENOTCONTROLLED | Die Datei befindet sich nicht unter der Quellcodeverwaltung. |
| SCC_E_ACCESSFAILURE | Es gab ein Problem beim Zugriff auf das Quellcodeverwaltungssystem, wahrscheinlich aufgrund von Netzwerk- oder Inhaltsproblemen. |
| SCC_E_NOTAUTHORIZED | Der Benutzer ist nicht berechtigt, diesen Vorgang abzuschließen. |
| SCC_E_COULDNOTCREATEPROJECT | Das Projekt konnte nicht als Teil des Umbenennungsprozesses erstellt werden. |
| SCC_E_OPNOTPERFORMED | Der Vorgang wurde nicht ausgeführt. |
| SCC_E_NONSPECIFICERROR | Es ist ein nicht angegebener oder allgemeiner Fehler aufgetreten. |
Hinweise
Diese Funktion kann verwendet werden, um eine Datei umzubenennen oder sie von einem Speicherort in ein anderes im Quellcodeverwaltungssystem zu verschieben. Das Quellcodeverwaltungs-Plug-In sollte nicht versuchen, auf die Datei auf dem Datenträger zuzugreifen. Es liegt in der Verantwortung der IDE, die lokale Datei umzubenennen.