list_filesT_list_filesListFilesListFileslist_files (Operator)

Name

list_filesT_list_filesListFilesListFileslist_files — List all files in a directory.

Signature

Description

list_fileslist_filesListFilesListFilesListFileslist_files returns all files in the directory given by DirectoryDirectoryDirectoryDirectorydirectorydirectory in the parameters FilesFilesFilesFilesfilesfiles. The current directory can be specified with ''"""""""""" or '.'".""."".""."".". The parameter OptionsOptionsOptionsOptionsoptionsoptions can be used to specify different processing options by passing a tuple of values. If OptionsOptionsOptionsOptionsoptionsoptions contains 'files'"files""files""files""files""files" only the files present in DirectoryDirectoryDirectoryDirectorydirectorydirectory are returned. If 'directories'"directories""directories""directories""directories""directories" is passed, only the directories present in DirectoryDirectoryDirectoryDirectorydirectorydirectory are returned. Directories are marked by a trailing '\'"\""\""\""\""\" (Windows) or a trailing '/'"/""/""/""/""/" (Unix-like systems). If files as well as directories should be returned, ['files','directories']["files","directories"]["files","directories"]["files","directories"]["files","directories"]["files","directories"] must be passed. If neither 'files'"files""files""files""files""files" nor 'directories'"directories""directories""directories""directories""directories" is passed, list_fileslist_filesListFilesListFilesListFileslist_files returns an empty tuple. By passing 'recursive'"recursive""recursive""recursive""recursive""recursive", it can be specified that the directory tree should be searched recursively by examining all sub-directories. On Unix-like systems, 'follow_links'"follow_links""follow_links""follow_links""follow_links""follow_links" can be used to specify that symbolic links to files or directories should be followed. In the default setting, symbolic links are not dereferenced, and hence are not searched if they point to directories, and not returned if they point to files. For the recursive search, a maximum search depth can be specified with 'max_depth <d>'"max_depth <d>""max_depth <d>""max_depth <d>""max_depth <d>""max_depth <d>", where '<d>'"<d>""<d>""<d>""<d>""<d>" is a number that specifies the maximum depth. Hence, 'max_depth 2'"max_depth 2""max_depth 2""max_depth 2""max_depth 2""max_depth 2" specifies that DirectoryDirectoryDirectoryDirectorydirectorydirectory and all immediate sub-directories should be searched. If symbolic links should be followed it might happen that the search does not terminate if the symbolic links lead to a cycle in the directory structure. Because of this, at most 1000000 files (and directories) are returned in FilesFilesFilesFilesfilesfiles. By specifying a different number with 'max_files <d>'"max_files <d>""max_files <d>""max_files <d>""max_files <d>""max_files <d>", this value can be reduced.

Execution Information

• Multithreading type: reentrant (runs in parallel with non-exclusive operators).
• Multithreading scope: global (may be called from any thread).
• Processed without parallelization.

Parameters

Result

list_fileslist_filesListFilesListFilesListFileslist_files returns the value TRUE if the directory exists and could be read. Otherwise, an exception is raised.

Possible Successors

tuple_regexp_selecttuple_regexp_selectTupleRegexpSelectTupleRegexpSelectTupleRegexpSelecttuple_regexp_select

Module

Foundation