fListDirectory (Function)

WINDEV, WEBDEV AND WINDEV MOBILE
ONLINE HELP

Version:

Home | Sign in | Français

Functions for managing external files

Procedure for managing each listed directory (syntax 2 only)

Interrupting fListDirectory (syntax 2)

Managing the errors

Related examples

See also

fListDirectory (Function)

In french: fListeRépertoire

Lists the subdirectories of a given directory and returns the full paths of listed subdirectories.

Other uses: For each directory found, fListDirectory can automatically call a special procedure written in WLanguage. This procedure is used to handle the current directory. In this case, fListDirectory returns the number of listed directories.

Versions 16 and later

This function is now available for Windows Phone applications.

New in version 16

This function is now available for Windows Phone applications.

Versions 18 and later

This function is now available in Windows Store apps mode.

New in version 18

This function is now available in Windows Store apps mode.

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

ADirectory, ResListDirectory are strings
DirectoryToList is string
DirectoryToList = "C:\MyDocuments"
// Windows Mobile: DirectoryToList = "\MyDocuments"

// List all the directories present in DirectoryToList.
ResListDirectory = fListDirectory(DirectoryToList)
// For each directory found
FOR EACH STRING ADirectory OF ResListDirectory SEPARATED BY CR
// Add the directory into TABLE_DirTable
TableAdd(TABLE_DirTable, ADirectory)
END

DirectoryToList = "C:\MyDocuments"
// Windows Mobile: DirectoryToList = "\MyDocuments"

// List the directories present in DirectoryToList.
// The DirectoryAttribute procedure returns the number of read-only directories.
ResListDirectory = fListDirectory(DirectoryToList, "DirectoryAttribute")

Syntax

Listing the subdirectories of a directory Hide the details

<Result> = fListDirectory(<Path of initial directory> [, <Options>])

<Result>: Character string

Name of listed directories, separated by CR characters (Carriage Return).

<Path of initial directory>: Character string (with quotes)

Path of directory from which the subdirectories will be sought.
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.
Versions 16 and later
The directory path corresponds to a relative path in relation to the current directory. The current directory corresponds to the data directory of application.
Reminder: Only the directories found in the data directory associated with the application can be used.
New in version 16
The directory path corresponds to a relative path in relation to the current directory. The current directory corresponds to the data directory of application.
Reminder: Only the directories found in the data directory associated with the application can be used.
The directory path corresponds to a relative path in relation to the current directory. The current directory corresponds to the data directory of application.
Reminder: Only the directories found in the data directory associated with the application can be used.

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

Options that can be taken into account:
fPathUNICODE
Versions 15 and later
<Result> will be a string in Unicode format.
New in version 15
<Result> will be a string in Unicode format.
<Result> will be a string in Unicode format.
Versions 16 and later
This constant is ignored.
New in version 16
This constant is ignored.
This constant is ignored.
fdInterruptible The browse can be interrupted by pressing the ESC key. The function will return the name of directories listed until the interruption.
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.

Listing the subdirectories of a directory by calling a procedure for each directory Hide the details

<Result> = fListDirectory(<Path of initial directory> , <Procedure name> [, <Pointer> [, <Options>]])

<Result>: Integer

Number of listed directories.

<Path of initial directory>: Character string (with quotes)

Path of directory from which the subdirectories will be sought.
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.

<Procedure name>: Character string (with or without quotes)

Name of WLanguage procedure ("callback") called for each listed directory. This procedure is used to handle the current directory. This procedure has the following format:

PROCEDURE <Procedure name> (<Path>, <Directory name>, <Change>,
<Procedure pointer>)

The parameters of this procedure are optional.
There is no need to pass parameters to this procedure. Indeed, these parameters are automatically filled whenever a directory is processed.

<Pointer>: Optional integer

Pointer passed to <Procedure name>.

<Options>: Combination of Integer constants

Type of browse performed for the directory files:
fPathUNICODE
Versions 15 and later
<Result> will be a string in Unicode format.
New in version 15
<Result> will be a string in Unicode format.
<Result> will be a string in Unicode format.
fdInterruptible The browse can be interrupted by pressing the ESC key. The function will return the number of directories listed until the interruption.
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.

Remarks

Procedure for managing each listed directory (syntax 2 only)

For each directory found, fListDirectory automatically calls the procedure <Procedure name>. This procedure is a local or global procedure.

To create this procedure:

Create a global procedure ("Insert .. New global procedure" in the code editor).Create a global procedure (from the code editor: on the "Code" pane, in the "Procedures" group, expand "New" and select "New global procedure").

Fill the procedure declaration as follows:

PROCEDURE <Procedure name> (<Path>, <Directory name>, <Change>,
<Procedure pointer>)

<Path> is the directory path used (it always ends with a "\" character; "C:\MyFiles\" for example).
<Directory name> is a character string containing the name of directory found.

<Change> is a constant set to:

flChangeDir when the directory is the first directory listed in a subdirectory of <Path> (a change of directory occurred),

fDirectory in all the other cases.

The different values that can be taken by <Change> are as follows:

Current directory	<Change>

Dir\Directory 1	flDirectory
Dir\Directory n	flDirectory
Dir\SubDir 1\Directory 1	flChangeDir
Dir\SubDir 1\Directory m	flDirectory
Dir\SubDir 2\Directory 1	flChangeDir
Sub\SubDir 2\Directory x	flDirectory

<Procedure pointer> is an integer whose value is the one passed to the <Pointer> parameter of fListDirectory. If <Pointer> is not specified, <Pointer> is set to 0.

To retrieve the value of <Procedure pointer>, assign its value to the value of <Pointer> in the procedure with Transfer (see the detailed example at the top of the page).

Remark: The parameters of this procedure are optional: you have the ability to specify the name and the path for example.

Interrupting fListDirectory (syntax 2)

As long as there are directories to browse, fListDirectory cannot be interrupted. To force the interruption of the browse, use the following code line in the <Procedure name> procedure:

RESULT False

In this case, fListDirectory returns the number of directories browsed until the call to "Result False".

In any other case (to continue the browse), <Procedure name> MUST return True.

An error is generated if <Procedure name> returns no value (neither True nor False).

Managing the errors

Caution: fListDirectory returns no error code. To find out whether an error was generated by this function, use ErrorInfo with the constant errMessage.

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