SccRemove-Funktion

Artikel
01/13/2024

Diese Funktion löscht Dateien aus dem Quellcodeverwaltungssystem.

Syntax

SCCRTN SccRemove(
   LPVOID    pvContext,
   HWND      hWnd,
   LONG      nFiles,
   LPCSTR*   lpFileNames,
   LPCSTR    lpComment,
   LONG      fOptions,
   LPCMDOPTS pvOptions
);

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.

nFiles

[in] Die Anzahl der im lpFileNames Array angegebenen Dateien.

lpFileNames

[in] Array von vollqualifizierten lokalen Pfadnamen von Dateien, die entfernt werden sollen.

lpComment

[in] Der Kommentar, der auf jede zu entfernende Datei angewendet werden soll.

Foptions

[in] Befehlskennzeichnungen (nicht verwendet).

pvOptions

[in] Plug-In-spezifische Optionen für die Quellcodeverwaltung.

Rückgabewert

Die Plug-In-Implementierung dieser Funktion für die Quellcodeverwaltung wird voraussichtlich einen der folgenden Werte zurückgeben:

Wert	Beschreibung
SCC_OK	Die Entfernung war erfolgreich.
SCC_E_FILENOTCONTROLLED	Die ausgewählte Datei befindet sich nicht unter der Quellcodeverwaltung.
SCC_E_OPNOTSUPPORTED	Das Quellcodeverwaltungssystem unterstützt diesen Vorgang nicht.
SCC_E_ISCHECKEDOUT	Eine Datei kann nicht entfernt werden, da ein Benutzer sie zurzeit ausgecheckt hat.
SCC_E_ACCESSFAILURE	Es gab ein Problem beim Zugriff auf das Quellcodeverwaltungssystem, wahrscheinlich aufgrund von Netzwerk- oder Inhaltsproblemen.
SCC_E_NOTAUTHORIZED	Der Benutzer darf diesen Vorgang nicht ausführen.
SCC_E_NONSPECIFICERROR	Nicht spezifischer Fehler; Die Datei wurde nicht entfernt.
SCC_I_OPERATIONCANCELED	Der Vorgang wurde vor Abschluss abgebrochen.

Hinweise

Diese Funktion entfernt die Dateien aus dem Quellcodeverwaltungssystem, löscht sie jedoch nicht von der lokalen Festplatte des Benutzers.

Siehe auch

API-Funktionen von Quellcodeverwaltungs-Plug-Ins

Freigeben über