list_files — Auflisten aller Dateien in einem Verzeichnis.
list_files gibt in Files alle Dateien im
Verzeichnis Directory zurück. Das aktuelle Verzeichnis
kann mit '' oder '.' angegeben werden. Mit dem
Parameter Options können verschiedene Ausführungsoptionen
festgelegt werden, indem ein Tupel von Werten übergeben wird.
Wird in Options 'files' übergeben, so werden
ausschließlich die in Directory vorhandenen Dateien
zurückgegeben. Wird 'directories' übergeben, so werden
ausschließlich die vorhandenen Verzeichnisse zurückgegeben. Die
Verzeichnisse werden dabei durch ein abschließendes
'' (Windows) bzw.
'/' (unixartige Systeme) gekennzeichnet.
Falls sowohl Dateien als auch
Verzeichnisse zurückgegeben werden sollen, muss
['files','directories'] übergeben werden.
Falls weder
'files' noch 'directories'
übergeben wird, liefert list_files ein leeres Tupel zurück.
Mit 'recursive' kann festgelegt werden, dass der Verzeichnisbaum rekursiv unter Einbeziehung aller Unterverzeichnisse durchsucht werden soll. Unter unixartigen Systemen kann mit 'follow_links' festgelegt werden, ob symbolische Links auf Dateien oder Verzeichnisse verfolgt werden oder nicht. In der Voreinstellung ohne 'follow_links' werden symbolische Links nicht dereferenziert und somit auch nicht verfolgt, falls sie auf Verzeichnisse zeigen, oder zurückgeliefert, falls sie auf Dateien zeigen.
Bei der rekursiven Suche kann mit
'max_depth <d>'
eine maximale Tiefe der Suche
festgelegt werden, wobei '<d>' eine Zahl
ist, die die Tiefe festlegt. So legt
z.B. 'max_depth 2' fest, dass Directory und alle
direkten Unterverzeichnisse von Directory durchsucht
werden. Falls symbolische Links verfolgt werden sollen, könnte es
sein, dass die Suche nicht terminiert, falls die symbolischen Links
zu einem Zyklus in der Verzeichnisstruktur führen. Deswegen werden
in Files höchstens 1000000 Dateien (und Verzeichnisse)
zurückgegeben.
Mit 'max_files <d>' kann dieser
Wert angepasst werden.
Directory (input_control) filename.dir → (string)
Name des aufzulistenden Verzeichnisses.
Options (input_control) string(-array) → (string)
Ausführungsoptionen.
Defaultwert: 'files'
Wertevorschläge: 'files', 'directories', 'recursive', 'follow_links', 'max_depth 5', 'max_files 1000'
Files (output_control) string-array → (string)
Gefundene Dateien (und Verzeichnisse).
list_files liefert den Wert 2 (H_MSG_TRUE), falls das zu untersuchende
Verzeichnis existiert und gelesen werden konnte. Andernfalls wird
eine Fehlerbehandlung durchgeführt.
Foundation