list_filesT_list_filesListFilesListFiles (Operator)

Name

list_filesT_list_filesListFilesListFiles — Auflisten aller Dateien in einem Verzeichnis.

Signatur

list_files( : : Directory, Options : Files)

Herror T_list_files(const Htuple Directory, const Htuple Options, Htuple* Files)

void ListFiles(const HTuple& Directory, const HTuple& Options, HTuple* Files)

static HTuple HMisc::ListFiles(const HString& Directory, const HTuple& Options)

static HTuple HMisc::ListFiles(const HString& Directory, const HString& Options)

static HTuple HMisc::ListFiles(const char* Directory, const char* Options)

static HTuple HMisc::ListFiles(const wchar_t* Directory, const wchar_t* Options)   (Nur Windows)

static void HOperatorSet.ListFiles(HTuple directory, HTuple options, out HTuple files)

static HTuple HMisc.ListFiles(string directory, HTuple options)

static HTuple HMisc.ListFiles(string directory, string options)

Beschreibung

list_fileslist_filesListFilesListFilesListFiles gibt in FilesFilesFilesFilesfiles alle Dateien im Verzeichnis DirectoryDirectoryDirectoryDirectorydirectory zurück. Das aktuelle Verzeichnis kann mit ''"""""""" oder '.'".""."".""." angegeben werden. Mit dem Parameter OptionsOptionsOptionsOptionsoptions können verschiedene Ausführungsoptionen festgelegt werden, indem ein Tupel von Werten übergeben wird. Wird in OptionsOptionsOptionsOptionsoptions 'files'"files""files""files""files" übergeben, so werden ausschließlich die in DirectoryDirectoryDirectoryDirectorydirectory vorhandenen Dateien zurückgegeben. Wird 'directories'"directories""directories""directories""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']["files","directories"]["files","directories"]["files","directories"]["files","directories"] übergeben werden. Falls weder 'files'"files""files""files""files" noch 'directories'"directories""directories""directories""directories" übergeben wird, liefert list_fileslist_filesListFilesListFilesListFiles ein leeres Tupel zurück. Mit 'recursive'"recursive""recursive""recursive""recursive" kann festgelegt werden, dass der Verzeichnisbaum rekursiv unter Einbeziehung aller Unterverzeichnisse durchsucht werden soll. Unter unixartigen Systemen kann mit 'follow_links'"follow_links""follow_links""follow_links""follow_links" festgelegt werden, ob symbolische Links auf Dateien oder Verzeichnisse verfolgt werden oder nicht. In der Voreinstellung ohne 'follow_links'"follow_links""follow_links""follow_links""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>'"max_depth <d>""max_depth <d>""max_depth <d>""max_depth <d>" eine maximale Tiefe der Suche festgelegt werden, wobei '<d>'"<d>""<d>""<d>""<d>" eine Zahl ist, die die Tiefe festlegt. So legt z.B. 'max_depth 2'"max_depth 2""max_depth 2""max_depth 2""max_depth 2" fest, dass DirectoryDirectoryDirectoryDirectorydirectory und alle direkten Unterverzeichnisse von DirectoryDirectoryDirectoryDirectorydirectory 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 FilesFilesFilesFilesfiles höchstens 1000000 Dateien (und Verzeichnisse) zurückgegeben. Mit 'max_files <d>'"max_files <d>""max_files <d>""max_files <d>""max_files <d>" kann dieser Wert herabgesetzt werden.

Ausführungsinformationen

Parameter

DirectoryDirectoryDirectoryDirectorydirectory (input_control)  filename.dir HTupleHTupleHtuple (string) (string) (HString) (char*)

Name des aufzulistenden Verzeichnisses.

OptionsOptionsOptionsOptionsoptions (input_control)  string(-array) HTupleHTupleHtuple (string) (string) (HString) (char*)

Ausführungsoptionen.

Defaultwert: 'files' "files" "files" "files" "files"

Wertevorschläge: 'files'"files""files""files""files", 'directories'"directories""directories""directories""directories", 'recursive'"recursive""recursive""recursive""recursive", 'follow_links'"follow_links""follow_links""follow_links""follow_links", 'max_depth 5'"max_depth 5""max_depth 5""max_depth 5""max_depth 5", 'max_files 1000'"max_files 1000""max_files 1000""max_files 1000""max_files 1000"

FilesFilesFilesFilesfiles (output_control)  string-array HTupleHTupleHtuple (string) (string) (HString) (char*)

Gefundene Dateien (und Verzeichnisse).

Ergebnis

list_fileslist_filesListFilesListFilesListFiles liefert den Wert 2 (H_MSG_TRUE), falls das zu untersuchende Verzeichnis existiert und gelesen werden konnte. Andernfalls wird eine Fehlerbehandlung durchgeführt.

Nachfolger

tuple_regexp_selecttuple_regexp_selectTupleRegexpSelectTupleRegexpSelectTupleRegexpSelect

Modul

Foundation