Die Bibliothek SysLibFile.

lib

Die Bibliothek [Link]

Diese Bibliothek unterstützt synchrone Dateizugriffe auf dem Zielrechner. Wenn das Zielsystem die
Funktionalität beinhaltet, können folgende Bibliotheksfunktionen für den Umgang mit den Dateien
verwendet werden:

• SysFileOpen Datei öffnen

• SysFileClose Datei schließen

• SysFileWrite in Datei schreiben

• SysFileRead aus Datei lesen

• SysFileDelete Datei löschen

• SysFileGetPos aktuellen Offset in Datei ermitteln

• SysFileSetPos Offset in Datei setzen

• SysFileEOF Prüfen, ob Ende der Datei erreicht ist

• SysFileGetSize Dateigröße ermitteln

• SysFileGetTime Zeitangaben bzgl. Erstellung, Zugriff, Änderung

• SysFileCopy Datei kopieren

• SysFileRename Datei umbenennen

SysFileOpen
Diese Funktion vom Typ DWORD dient dem Öffnen einer bereits bestehenden oder neu zu
generierenden Datei.
Der Rückgabewert ist eine 'Datei-Nummer', die in den Funktionen SysFileWrite, SysFileRead,
SysFileClose als Eingabe ('File') verwendet wird. Im Fehlerfall wird '0' zurückgegeben bzw. (Achtung
Ausnahme!) '-1' von Zielsystem CoDeSys SP RTE.

Input-Variable Datentyp Beschreibung

FileName STRING Datei-Name
Mode STRING Modus, in dem die Datei bearbeitet werden soll:
w write (Datei wird überschrieben oder neu angelegt)
r read (Datei wird nur zum Lesen geöffnet; wenn die
Datei nicht existiert, wird ein Fehler zurückgegeben)
rw read and write (Datei wird überschrieben; wenn die Datei
nicht existiert, wird ein Fehler zurückgegeben)
a append (Datei wird wie mit 'w' geöffnet, aber beim
Schreiben wird am Dateiende angehängt)

© 3S – Smart Software Solutions GmbH / 12.01.2006/ CoDeSys V2.3 1

 Die Bibliothek [Link]

SysFileClose
Diese Funktion vom Typ BOOL dient dem Schließen einer Datei, die mit SysFileOpen geöffnet
worden war.
Der Rückgabewert ist 1 (ok) oder 0 (Fehler).

Variable Datentyp Beschreibung

File DWORD Datei-Nummer (aus SysFileOpen)

SysFileWrite
Diese Funktion vom Typ DWORD dient zum Schreiben von Daten in die Datei, die zuvor über die
Funktion SysFileOpen geöffnet wurde.
Als Rückgabewert erhält man die Anzahl der erfolgreich geschriebenen Bytes.

Variable Datentyp Beschreibung

File DWORD Datei-Nummer (siehe SysFileOpen)
Buffer DWORD Adresse des Buffers (ermittelbar mit dem Hilfe des Operators ADR) der
zu schreibenden Daten
Size DWORD Anzahl der Bytes, die in die Datei geschrieben werden sollen
(ermittelbar mit Hilfe des Operators SIZEOF )

Beispiel:
WriteBuffer : ARRAY[0..5] OF BYTE:=0,1,2,4,5,6;
DwWritten : DWORD;
hFile : DWORD;

SysFileRead
Diese Funktion vom Typ DWORD dient zum Lesen einer Datei, die zuvor mit SysFileOpen geöffnet
wurde.
Als Rückgabewert erhält man die Anzahl der erfolgreich gelesenen Bytes.

Variable Datentyp Beschreibung

File DWORD Datei-Nummer (siehe SysFileOpen)
Buffer DWORD Adresse des Buffers der zu lesenden Daten (ermittelbar mit dem Hilfe
des Operators ADR)
Size DWORD Anzahl der Bytes, die aus dem Buffer gelesen werden sollen

Beispiel:

ReadBuffer : ReadBuffer:ARRAY[0..5] OF BYTE;

hFile : DWORD;
dwRead : DWORD;

2 © 3S – Smart Software Solutions GmbH / 12.01.2006/ CoDeSys V2.3

 Die Bibliothek [Link]

SysFileDelete
Diese Funktion vom Typ BOOL dient dem Löschen einer Datei.
Der Rückgabewert ist 1 (ok) oder 0 (Fehler).
Variable Datentyp Beschreibung
FileName STRING Datei-Name

SysFileGetPos
Diese Funktion vom Typ DINT gibt die aktuell gesetzte Offset-Position in einer Datei, die mit der aus
SysFileOpen erhaltenen Dateinummer angegeben wird, zurück.

Variable Datentyp Beschreibung

File DWORD Datei-Nummer (aus SysFileOpen)

SysFileSetPos
Diese Funktion vom Typ BOOL dient dazu, den aktuellen Offset (der über SysFileGetPos gelesen
werden kann) für einen Dateizugriff zu verändern. Die Datei wird mit der aus SysFileOpen erhaltenen
Dateinummer angegeben.
Variable Datentyp Beschreibung
File DWORD Datei-Nummer (siehe SysFileOpen)
Pos DWORD Offset innerhalb der Datei, der für Zugriffe gilt

SysFileEOF
Diese Funktion vom Typ BOOL liefert 1, wenn der aktuelle Offset am Ende der Datei steht; sie liefert
0, wenn das Dateiende noch nicht erreicht ist.

Variable Datentyp Beschreibung

File DWORD Datei-Nummer (siehe SysFileOpen)

SysFileGetSize
Diese Funktion vom Typ DINT liefert als Rückgabewert die Größe der mit FileName angegebenen
Datei in Bytes.
Variable Datentyp Beschreibung
FileName STRING Datei-Name

© 3S – Smart Software Solutions GmbH / 12.01.2006/ CoDeSys V2.3 3

 Die Bibliothek [Link]

SysFileGetTime
Diese Funktion vom Typ BOOL liefert den Zeitpunkt der Erstellung, des letzten Zugriffs und der letzten
Modifikation der Datei (angegeben mit FileName) im Format DT. Zu diesem Zweck kann auf die
Elemente der Struktur FILETIME zugegriffen werden.
Der Rückgabewert ist 1 (ok) oder 0 (Fehler).

Variable Datentyp Beschreibung

FileName STRING Datei-Name
ftFileTime POINTER TO FILETIME Zeigt auf Struktur FILETIME; der Operator ADR kann
hierbei zu Hilfe genommen werden

Struktur FILETIME:
TYPE FILETIME
STRUCT
dtCreation:DT; (* Erstelldatum *)
dtLastAccess:DT; (* Datum letzter Zugriff *)
dtLastModification:DT; (* Datum letzte Änderung *)
END_STRUCT
END_TYPE

Beispiel: Für die Datei 'TestFile' wird das Erstellungsdatum ausgelesen:

Ft : FILETIME;
filecreationtime : DT;

SysFileCopy
Diese Funktion vom Typ UDINT dient dazu, den Dateiinhalt in eine Datei mit anderem Namen zu
kopieren. Als Rückgabewert erhält man die Anzahl der kopierten Bytes.
Variable Datentyp Beschreibung
FileDest STRING Datei, in die kopiert werden soll
FileSource STRING Datei, aus der kopiert werden soll

4 © 3S – Smart Software Solutions GmbH / 12.01.2006/ CoDeSys V2.3

 Die Bibliothek [Link]

SysFileRename
Diese Funktion vom Typ BOOL dient dem Umbenennen einer Datei.
Der Rückgabewert ist 1 (ok) oder 0 (Fehler).

Variable Datentyp Beschreibung

FileOldName STRING Bisheriger Datei-Name
FileNewName STRING Neuer Datei-Name

© 3S – Smart Software Solutions GmbH / 12.01.2006/ CoDeSys V2.3 5