Sie sind auf Seite 1von 7

Bibliotheksbeschreibung:

CoDeSys V 3.x
SysDir.library

libdoc_d.dot / V1.0

Dokument Version 1.0

3S - Smart Software Solutions GmbH


SysDir_V3x_D.doc

Seite 1 von 7

Bibliothek SysDir.library

INHALT
1

BERBLICK

BIBLIOTHEKSBAUSTEINE

2.1

SysDirCreate

2.2

SysDirOpen

2.3

SysDirRead

2.4

SysDirDelete

2.5

SysDirRename

2.6

SysDirGetCurrent

2.7

SysDirSetCurrent

2.8

SysDirClose

2.9

DirFileTime

2.10

DirInfo

libdoc_d.dot / V1.0

NDERUNGSHISTORIE

3S - Smart Software Solutions GmbH


SysDir_V3x_D.doc

Seite 2 von 7

Bibliothek SysDir.library

berblick
Hinweis: Es hngt vom verwendeten Zielsystem ab, welche Systembibliotheken im Steuerungsprogramm verwendet
werden knnen.

Diese Bibliothek untersttzt die Verwaltung von Verzeichnissen. Wenn das Zielsystem die
Funktionalitt beinhaltet, knnen folgende Funktionen verwendet werden, um ein Verzeichnis
anzulegen, zu ffnen, zu lesen und zu schlieen.
SysDirOpen
SysDirCreate
SysDirRead
SysDirRename
SysDirSetCurrent
SysDirGetCurrent
SysDirClose
SysDirDelete
Die Funktionen verwenden folgende Strukturen:
DirFileTime

libdoc_d.dot / V1.0

DirInfo

3S - Smart Software Solutions GmbH


SysDir_V3x_D.doc

Seite 3 von 7

SysDir.library

2.1

Bibliotheksbausteine

SysDirCreate
Diese Funktion dient dem Anlegen eines Dateiverzeichnisses.
Der Rckgabewert vom Typ UDINT gibt den Fehlercode der Operation zurck. Dieser gibt
Auskunft ber den Erfolg der Operation.

2.2

Input-Variable

Datentyp

Beschreibung

szDir

REFERENCE TO
STRING

Verzeichnisname

SysDirOpen
Diese Funktion dient dazu, ein Verzeichnis zu ffnen, dessen Eintrge (Dateien,
Unterverzeichnisse) mit Hilfe der Funktion SysDirRead gelesen werden sollen.
Der Rckgabewert vom Typ UDINT ist ein Handle, das von SysDirRead als Eingabe verlangt
wird. Im Fehlerfall wird ein ungltiges Handle (-1) zurckgegeben.
Um das Verzeichnis zu schlieen, muss die Funktion SysDirRead aufgerufen werden, bis sie
0 zurckliefert.

2.3

Input-Variable

Datentyp

Beschreibung

szDir

REFERENCE TO
STRING

Name des zu ffnenden Verzeichnisses

szDirEntry

REFERENCE TO
STRING

Beinhaltet den ersten Eintrag (Unterverzeichnis oder


Datei) des geffneten Verzeichnisses.

diMaxDirEntry

DINT

Maximale Lnge des Eintrags in szDirEntry

pDirInfo

POINTER TO
DirInfo

Zeiger auf die Struktur DirInfo (siehe Kap. 2.10), die


Informationen zu dem geffneten Verzeichnis
beinhaltet.

pResult

POINTER TO
UDINT

Zeiger auf das Ergebnis der Funktion. Das Ergebnis


gibt Auskunft ber den Erfolg der Operation.

SysDirRead
Diese Funktion dient dazu, Verzeichniseintrge zu lesen.

libdoc_d.dot / V1.0

Die Funktion liest mit jedem Aufruf einen Eintrag aus dem Verzeichnis. Solange der
Rckgabewert (UDINT) "1" ist, ist ein weiterer Eintrag im Verzeichnis vorhanden. D.h. zum
Erfassen aller Eintrge muss die Funktion wiederholt aufgerufen werden, bis schlielich "0"
zurckgegeben wird. Dann wird das Verzeichnis geschlossen und das Handle ist nicht mehr
gltig. Die Funktion muss in jedem Fall solange aufgerufen werden, bis sie 0 zurckliefert,
damit das Verzeichnis geschlossen wird.
Die Information zu den einzelnen Eintrgen wird in die Struktur DirInfo geschrieben.
Input-Variable

Datentyp

Beschreibung

hDir

UDINT

Handle des Verzeichnisses; Rckgabewert der


Funktion SysDirOpen, mit der das Verzeichnis zuvor
geffnet wurde.

3S - Smart Software Solutions GmbH


SysDir_V3x_D.doc

Seite 4 von 7

SysDir.library

2.4

Input-Variable

Datentyp

Beschreibung

szDirEntry

STRING

String der mit dem Namen eines Eintrags im


Verzeichnis gefllt wird. Kann eine Datei oder ein
weiteres Verzeichnis sein.

dMaxDirEntry

DINT

Maximale Lnge des String-Eintrags, der nach dem


Lesen in szDirEntry geschrieben wird.

pDirInfo

POINTER TO
DirInfo

Zeiger auf die Struktur DirInfo, die mit Informationen


zum gelesenen Eintrag gefllt wird. Der Pointer kann
auch "0" sein, dann wird diese Information nicht
gelesen.

SysDirDelete
Diese Funktion dient dazu, ein Verzeichnis zu lschen.
Der Rckgabewert vom Typ UDINT gibt den Fehlercode der Operation zurck. Dieser gibt
Auskunft ber den Erfolg der Operation.

2.5

Input-Variable

Datentyp

Beschreibung

szDir

STRING

Name des zu lschenden Verzeichnisses

SysDirRename
Diese Funktion dient dem Umbenennen eines Verzeichnisses.
Der Rckgabewert vom Typ UDINT gibt den Fehlercode der Operation zurck. Dieser gibt
Auskunft ber den Erfolg der Operation.

2.6

Input-Variable

Datentyp

Beschreibung

szOldDirName

STRING

bisheriger Verzeichnisname

szNewDirName

STRING

neuer Verzeichnisname

SysDirGetCurrent
Diese Funktion gibt das aktuelle Verzeichnis zurck.
Der Rckgabewert vom Typ UDINT gibt den Fehlercode der Operation zurck. Dieser gibt
Auskunft ber den Erfolg der Operation.
Datentyp

Beschreibung

szDir

REFERENCE TO
STRING

In diesen String wird der Name des aktuellen


Verzeichnisses geschrieben

dMaxDirLen

DINT

Maximale Lnge des Strings in szDir

libdoc_d.dot / V1.0

Input-Variable

3S - Smart Software Solutions GmbH


SysDir_V3x_D.doc

Seite 5 von 7

SysDir.library

2.7

SysDirSetCurrent
Diese Funktion dient dem Setzen des aktuellen Verzeichnisses.
Der Rckgabewert vom Typ UDINT gibt den Fehlercode der Operation zurck. Dieser gibt
Auskunft ber den Erfolg der Operation.

2.8

Input-Variable

Datentyp

Beschreibung

szDir

STRING

Name des Verzeichnisses, das als aktuell gesetzt


werden soll.

SysDirClose
Diese Funktion dient dem Schlieen des mit SysDirOpen geffneten Verzeichnisses.
Der Rckgabewert vom Typ UDINT gibt den Fehlercode der Operation zurck. Dieser gibt
Auskunft ber den Erfolg der Operation.

2.9

Input-Variable

Datentyp

Beschreibung

hDir

UDINT

Handle des Verzeichnisses; Rckgabewert der


Funktion SysDirOpen

DirFileTime
Diese Struktur enthlt Informationen zu Datum und Uhrzeit der Erstellung, des letzten Zugriffs
und der letzten nderung eines Verzeichniseintrags. Sie wird von Struktur DirInfo verwendet.
Die Daten werden im IEC Zeitformat angegeben.
Strukturkomponente

Datentyp

Bedeutung

ulCreation

UDINT

Erstelldatum

ulLastAccess

UDINT

Datum des letzten Zugriffs

ulLastModification

UDINT

Datum der letzten nderung

2.10 DirInfo
Diese Struktur enthlt Informationen zu einem Verzeichniseintrag, der ber die Funktion
SysDirRead gelesen wird:
Datentyp

tDirFileTime

DIRFILETIME Struktur mit Information zu Erstell-, nderungs-,


Zugriffsdatum des Verzeichniseintrags

ulSize

UDINT

Gre des Verzeichniseintrags (der Datei)

diDirectory

DINT

TRUE, wenn der Eintrag ein Verzeichnis ist, FALSE


wenn es eine Datei ist

3S - Smart Software Solutions GmbH


SysDir_V3x_D.doc

Seite 6 von 7

libdoc_d.dot / V1.0

Strukturkomponente

Bedeutung

SysDir.library

nderungshistorie
Beschreibung

Datum

0.1

Erstellung

27.06.2007

0.2

Review

19.07.2007

1.0

Freigabe

19.07.2007

libdoc_d.dot / V1.0

Version

3S - Smart Software Solutions GmbH


SysDir_V3x_D.doc

Seite 7 von 7