HALCON Reference Manual 10.0.2
Table of Contents / File / Misc ClassesClassesClasses | | | Operators

list_filesT_list_fileslist_filesListFilesListFiles (Operator)

Name

list_filesT_list_fileslist_filesListFilesListFiles — List all files in a directory.

Signature

list_files( : : Directory, Options : Files)

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

Herror list_files(const HTuple& Directory, const HTuple& Options, HTuple* Files)

void HOperatorSetX.ListFiles(
[in] VARIANT Directory, [in] VARIANT Options, [out] VARIANT* Files)

VARIANT HMiscX.ListFiles(
[in] BSTR Directory, [in] VARIANT Options)

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)

Description

list_fileslist_fileslist_filesListFilesListFiles returns all files in the directory given by DirectoryDirectoryDirectoryDirectorydirectory in the parameters FilesFilesFilesFilesfiles. The current directory can be specified with ''"""""""" or '.'"."".""."".". The parameter OptionsOptionsOptionsOptionsoptions can be used to specify different processing options by passing a tuple of values. If OptionsOptionsOptionsOptionsoptions contains 'files'"files""files""files""files" only the files present in DirectoryDirectoryDirectoryDirectorydirectory are returned. If 'directories'"directories""directories""directories""directories" is passed, only the directories present in DirectoryDirectoryDirectoryDirectorydirectory are returned. Directories are marked by a trailing '\'"\""\""\""\" (Windows) or a trailing '/'"/""/""/""/" (Unix). If files as well as directories should be returned, ['files','directories']["files","directories"]["files","directories"]["files","directories"]["files","directories"] must be passed. If neither 'files'"files""files""files""files" nor 'directories'"directories""directories""directories""directories" is passed, list_fileslist_fileslist_filesListFilesListFiles returns an empty tuple. By passing 'recursive'"recursive""recursive""recursive""recursive", it can be specified that the directory tree should be searched recursively by examining all sub-directories. On Unix systems, '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>", where '<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" specifies that DirectoryDirectoryDirectoryDirectorydirectory 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 FilesFilesFilesFilesfiles. By specifying a different number with 'max_files <d>'"max_files <d>""max_files <d>""max_files <d>""max_files <d>", this value can be reduced.

Parallelization

Parameters

DirectoryDirectoryDirectoryDirectorydirectory (input_control)  filename.dir → HTupleHTupleVARIANTHtuple (string) (string) (char*) (BSTR) (char*)

Name of directory to be listed.

OptionsOptionsOptionsOptionsoptions (input_control)  string(-array) → HTupleHTupleVARIANTHtuple (string) (string) (char*) (BSTR) (char*)

Processing options.

Default value: 'files' "files" "files" "files" "files"

Suggested values: '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 → HTupleHTupleVARIANTHtuple (string) (string) (char*) (BSTR) (char*)

Found files (and directories).

Result

list_fileslist_fileslist_filesListFilesListFiles returns the value 2 (H_MSG_TRUE) if the directory exists and could be read. Otherwise, an exception is raised.

Possible Successors

tuple_regexp_selecttuple_regexp_selecttuple_regexp_selectTupleRegexpSelectTupleRegexpSelect

Module

Foundation

Table of Contents / File / Misc ClassesClassesClasses | | | Operators
HALCON Reference Manual 10.0.2 Copyright © 1996-2011 MVTec Software GmbH