fListFile (Function)

ONLINE HELP
WINDEV, WEBDEV AND WINDEV MOBILE

Version:

Home | Sign in | English

External file management functions

Listing the subdirectories of a directory

Related examples

See also

fListFile (Function)

In french: fListeFichier

Lists the files found in a directory and returns the list of files. The listed files are sought from the given directory.

Other use: For each file found, fListFile can automatically call a specific procedure written in WLanguage. This procedure is used to handle the current file. In this case, fListFile returns the number of listed files.

Remark: In 64-bit Windows, the access to a system directory from a 32-bit executable can be performed in a directory that differs from the expected one. For more details, see Native 64-bit and native 32-bit.

Versions 15 and later

This function is now available for Android applications.

New in version 15

This function is now available for Android applications.

Versions 17 and later

This function is now available for iPhone/iPad applications.

New in version 17

This function is now available for iPhone/iPad applications.

Versions 18 and later

This function is now available in Android widget mode.

This function is now available in Windows Store apps mode.

This function is now available in the code of stored procedures.

New in version 18

This function is now available in Android widget mode.

This function is now available in Windows Store apps mode.

This function is now available in the code of stored procedures.

This function is now available in Android widget mode.

This function is now available in Windows Store apps mode.

This function is now available in the code of stored procedures.

Versions 21 and later

This function is now available in Universal Windows 10 App mode.

New in version 21

This function is now available in Universal Windows 10 App mode.

Example

See additional examples

UnFichier, ResListeFichier are strings
// Liste les fichiers de type ".BMP" présents dans "C:\MesDocuments".
// Le parcours se fait également dans les sous-répertoires et est interruptible.
ResListeFichier = fListFile("C:\MesDocuments\*.BMP", frRecursive + fdInterruptible)
// Pour chaque fichier trouvé
FOR EACH STRING UnFichier OF ResListeFichier SÉPARÉE BY CR
// Ajout du fichier dans la table TABLE_TableFic
TableAdd(TABLE_TableFic, UnFichier)
END

// Liste les fichiers de type ".BMP" présents dans "C:\MesDocuments".
// La procédure AttributFichier retourne le nombre de fichiers en lecture seule.
ResListeFichier = fListFile("C:\MesDocuments\*.BMP", "AttributFichier")

Syntax

Listing the files found in a directory Hide the details

<Result> = fListFile(<Path and generic name of files> , <Options>)

<Result>: Character string

Full name of listed files, separated by CR characters (Carriage Return).

Caution: The function returns files whose short or long name matches the filter.

<Path and generic name of files>: Character string

Path and generic name of files to list. Generic characters (* and?) are allowed. Special cases:
if the directory and the drive are not specified: the search path is built from the current drive and from the current directory for this drive.
if the drive is not specified while the directory is specified: the search path is built from the current drive and from the directory passed as parameter.
if the drive is specified while the directory is not specified, the search path is built from the specified drive and from the current directory for this drive.
Versions 15 and later
This parameter can be in Ansi or Unicode format.
New in version 15
This parameter can be in Ansi or Unicode format.
This parameter can be in Ansi or Unicode format.
This parameter can correspond to a full path or a path relative to the current directory (returned by fCurrentDir). This parameter is case-sensitive.
Reminder: In Android, the file system is read-only on the device and on the emulator. An application can only write to its setup directory or one of its subdirectories, as well as to the external memory (SDCard).
Versions 17 and later
This parameter can correspond to a full path or a path relative to the current directory (returned by fCurrentDir). This parameter is case-sensitive.
Reminder: On iPhone/iPad, an application has the rights to write into its setup directory or into one of its subdirectories.
New in version 17
This parameter can correspond to a full path or a path relative to the current directory (returned by fCurrentDir). This parameter is case-sensitive.
Reminder: On iPhone/iPad, an application has the rights to write into its setup directory or into one of its subdirectories.
This parameter can correspond to a full path or a path relative to the current directory (returned by fCurrentDir). This parameter is case-sensitive.
Reminder: On iPhone/iPad, an application has the rights to write into its setup directory or into one of its subdirectories.

<Options>: Combination of Integer constants

Option used to define the information returned as well as the type of browse performed for the directory files:
Versions 15 and later
fPathUNICODE
New in version 15
fPathUNICODE
fPathUNICODE <Result> will be a string in Unicode format.
fdFullInformation Each line (separated by carriage return - CR) contains the following information:

<Nom du fichier complet> + TAB + <Taille en octets> + TAB +
<Date de dernière modification> + TAB + <Attributs du fichier>

The date is in YYYYMMDDHHmmSS format. The attributes are identical to the ones returned by fAttribute.
fdInterruptible The browse can be interrupted by pressing the ESC key. The function will return the name of the listed files until the interruption.
frNotRecursive The browse is a non-recursive browse. Subdirectories are ignored.
frRecursive
(Default value) The browse is recursive. Subdirectories are automatically taken into account.
frNoHiddenFile If the frFullInformation constant is used, the hidden files are not listed (attribute = "H").
frNoHiddenDirectory If the frFullInformation constant is used, the hidden directories are not listed (attribute = "H").

This parameter is ignored.

Listing the files found in a directory by calling a procedure for each file Hide the details

<Result> = fListFile(<Path and generic name of files> , <WLanguage procedure> [, <Pointer> [, <Options>]])

<Result>: entier

Number of listed files.

<Path and generic name of files>: Character string

Path and generic name of files to list. Generic characters (* and?) are allowed. Special cases:
if the directory and the drive are not specified: the search path is built from the current drive and from the current directory for this drive.
if the drive is not specified while the directory is specified: the search path is built from the current drive and from the directory passed as parameter.
if the drive is specified while the directory is not specified, the search path is built from the specified drive and from the current directory for this drive.
This parameter can correspond to a full path or a path relative to the current directory (returned by fCurrentDir). This parameter is case-sensitive.
Reminder: In Android, the file system is read-only on the device and on the emulator. An application can only write to its setup directory or one of its subdirectories, as well as to the external memory (SDCard).
Versions 17 and later
This parameter can correspond to a full path or a path relative to the current directory (returned by fCurrentDir). This parameter is case-sensitive.
Reminder: On iPhone/iPad, an application has the rights to write into its setup directory or into one of its subdirectories.
New in version 17
This parameter can correspond to a full path or a path relative to the current directory (returned by fCurrentDir). This parameter is case-sensitive.
Reminder: On iPhone/iPad, an application has the rights to write into its setup directory or into one of its subdirectories.
This parameter can correspond to a full path or a path relative to the current directory (returned by fCurrentDir). This parameter is case-sensitive.
Reminder: On iPhone/iPad, an application has the rights to write into its setup directory or into one of its subdirectories.

<WLanguage procedure>: Procedure name

Name of the Procedure WLanguage (also called "callback") called for each listed file. This procedure is used to handle the current file. For more details on this procedure, see Parameters of the procedure used by fListFile.
The name of the procedure must correspond to a character string in quotes.

<Pointer>: Optional integer

Pointer passed to <WLanguage procedure>.
Parameter passed to the function. This parameter is not necessarily an integer (it can be a string, ...).

<Options>: Optional Integer constant (or combination of constants)

Type of browse performed for the directory files:
Versions 15 and later
fPathUNICODE
New in version 15
fPathUNICODE
fPathUNICODE <Result> will be a string in Unicode format.
fdInterruptible The browse can be interrupted by pressing the ESC key.
This constant has no effect.
frNotRecursive The browse is a non-recursive browse. Subdirectories are ignored.
frRecursive
(Default value) The browse is recursive. Subdirectories are automatically taken into account.
This parameter is ignored. The browse is a non-recursive browse and it cannot be interrupted.

Remarks

Error management

Caution: fListFile returns no error code. To determine if this function has generated an error, use ErrorInfo with the errMessage constant.

Listing the subdirectories of a directory

To list the subdirectories of a directory, use fListDirectory.

Tip: fListFile can also be used to list the subdirectories of a directory.
Example:

fListFile("c:\temp\anim\.", proc)
// Ne pas oublier le '.' à la fin de la chaîne pour identifier les répertoires

PROCÉDURE proc(Rep, fichier, nChange, ptr)
Trace(Rep)

Related Examples:

Unit examples (WINDEV): The fListFile function

[ + ] Using fListFile and its syntax that directly returns the list of files/directories found in string format.

Component: wd270std.dll