ft_delete() löscht eine Datei oder ein Dateiverzeichnis im fernen System. Dateiverzeichnisse, die gelöscht werden sollen, müssen leer sein.
Um eine Datei zu löschen, muss der Parameter filetype in der Struktur par den Wert FT_FILE enthalten.
Um ein Dateiverzeichnis zu löschen, muss der Parameter filetype in der Struktur par den Wert FT_DIRECTORY enthalten.
Dateinamen bzw. Dateiverzeichnisnamen dürfen die in der Struktur ft_prop im Feld maxrfnsize angegebene Länge nicht überschreiten (siehe Abschnitt „ft_properties -Eigenschaften der Programmschnittstelle ermitteln").
Syntax
#include <ftapi.h>
int ft_delete(const struct ft_admission *admis, /* Eingabe */
const struct ft_delpar *par, /* Eingabe */
struct ft_err *errorinfo,
void *options); /* Eingabe */
Parameter
admis
Angaben für das ferne System (siehe Abschnitt „ft_admission" (Angaben zum fernen System)).
par
Angaben für den Löschauftrag, die Sie mit der Struktur ft_delpar bekanntgeben:
struct ft_delpar
{
int delparvers; /* Eingabe */
char *fn; /* Eingabe */
char *mgmtpasswd; /* Eingabe */
enum ft_filedir filetype; /* Eingabe */
char *fud; /* Eingabe */
int fudlen; /* Eingabe */
};
Die Felder der Struktur ft_delpar haben folgende Bedeutung:
delparvers
Version der Datenstruktur.
delparvers muss mit dem Wert FT_DPARV1 oder FT_DPARV2 versorgt werden.
fn
Name der Datei oder des Dateiverzeichnisses im fernen System, die/das gelöscht werden soll.
Absolute und relative Pfadangaben sind erlaubt. Relative Pfadangaben beziehen sich auf die im Berechtigungsprofil festgelegte Benutzerkennung, wenn die FTAC-Funktion eingesetzt wird, sonst auf das HOME-Verzeichnis, siehe "Dateiübertragung".
mgmtpasswd
Kennwort der Datei/des Dateiverzeichnisses, falls sie/es mit einem Kennwort geschützt ist.
filetype
gibt an, was gelöscht werden soll:
FT_FILE
Datei (Defaultwert nach Initialisierung der Parameterliste ft_delpar mit binär 0)
FT_DIRECTORY
Dateiverzeichnis (nicht für FTAM-Partner)
fud
Adresse eines Datenbereichs für die sogenannten "Further Details", die im Fehlerfall eine genauere Fehlerursache angeben können.
Bei Angabe von NULL wird keine weiterführende Fehlerursache ausgegeben. Der Parameter fud steht nur dann zur Verfügung, wenn delparvers auf den Wert FT_DPARV2 gesetzt wird und beim Aufruf von ft_delete der Parameter options angegeben ist.
fudlen
Länge des Datenbereichs von fud.
Der Parameter fudlen steht nur dann zur Verfügung, wenn delparvers auf den Wert FT_DPARV2 gesetzt wird und beim Aufruf von ft_delete der Parameter options angegeben ist.
errorinfo
Bereich, in dem genauere Informationen hinterlegt sind, wenn ein Fehler aufgetreten ist (siehe Abschnitt „ft_err" (Fehlerbehandlung)).
Die Angabe des Parameters ist optional. Wenn Sie keine genaueren Fehlerinformationen benötigen, können Sie für errorinfo den Wert NULL angeben.
options
Die Angabe des Parameters options ist optional. Wird der Wert NULL angegeben, dann ist das Meldungsverhalten der Programmschnittstelle kompatibel zur Programmschnittstelle von openFT < V10.
Alternativ können durch die Angabe der Struktur ft_options (siehe Abschnitt „ft_options" (Version der Programmschnittstelle)) das openFT-Meldungsnummernschema ab openFT V10 und die Funktionserweiterungen aktiviert werden.
Rückgabewert
0 | Kein Fehler. Die Datei oder das Dateiverzeichnis wurde gelöscht. |
-1 | Fehler. Die Datei oder das Dateiverzeichnis wurde nicht gelöscht. |