fListFile (Function)

WINDEV, WEBDEV AND WINDEV MOBILE
ONLINE HELP

Version:

Home | Sign in | English

Functions for managing external files

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. See Native 64-bit and native 32-bit for more details.

Versions 15 and later

This function is now available for the Android applications.

New in version 15

This function is now available for the Android applications.

Versions 17 and later

This function is now available for the iPhone/iPad applications.

New in version 17

This function is now available for the 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

AFile, ResFileList are strings
// Lists the ".BMP" files found in "C:\MyDocuments".
// The browse is also performed in the subdirectories and it can be interrupted.
ResFileList = fListFile("\MyDocuments\*.BMP", frRecursive + frInterruptible)
// For each file found
FOR EACH STRING AFile OF ResFileList SEPARATED BY CR
// Add the file into TABLE_FileTable
TableAdd(TABLE_FileTable, AFile)
END

// Lists the ".BMP" files found in "C:\MyDocuments".
// The FileAttribute procedure returns the number of read-only files.
ResFileList = fListFile("C:\MyDocuments\*.BMP", "FileAttribute")

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 can return files whose short name corresponds to the filter used (while the long name does not correspond to this filter).

<Path and generic name of files>: Character string (with quotes)

Path and generic name of files to list. The 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 in 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.
Path and generic name of files to list. The generic characters (* and?) are allowed.
This parameter can correspond to a full path or to a relative path in relation 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 has the rights to write into its setup directory or into one of its subdirectories, as well as onto the external memory (SDCard).
Versions 17 and later
This parameter can correspond to a full path or to a relative path in relation 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 to a relative path in relation 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 to a relative path in relation 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.
This constant is ignored because <Result> is always a Unicode string.
fdFullInformation Each line (separated by carriage return - CR) contains the following information:

<Full file name> + TAB + <Size in bytes> + TAB +
<Date of last modification> + TAB + <File attributes>

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.
This constant has no effect in Windows Phone and Windows Store apps.
frNotRecursive The browse is a non-recursive browse. Subdirectories are ignored.
frRecursive
(Default value) The browse is a recursive browse. 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>: Integer

Number of listed files.

<Path and generic name of files>: Character string (with quotes)

Path and generic name of files to list. The 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 in 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.
Path and generic name of files to list. The generic characters (* and?) are allowed.
This parameter can correspond to a full path or to a relative path in relation 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 has the rights to write into its setup directory or into one of its subdirectories, as well as onto the external memory (SDCard).
Versions 17 and later
This parameter can correspond to a full path or to a relative path in relation 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 to a relative path in relation 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 to a relative path in relation 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 WLanguage procedure ("callback" procedure) that will be 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.
This constant is ignored because <Result> is always a Unicode string.
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 a recursive browse. Subdirectories are automatically taken into account.
This parameter is ignored. The browse is a non-recursive browse and it cannot be interrupted.

Remarks

Managing errors

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

Equivalence

The operating mode of fListFile is equivalent to the operating mode of ceListFile.

The only difference is:

fListFile uses a directory on the Pocket PC from a WINDEV Mobile application.
ceListFile uses a directory on the Pocket PC from a standard WINDEV application.

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)
// Don't forget the '.' at the end of string to identify the directories

PROCÉDURE proc(Dir, file, nChange, ptr)
Trace(Dir)

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 : wd250std.dll