FTPListFile (Function)

WINDEV, WEBDEV AND WINDEV MOBILE
ONLINE HELP

Version:

Home | Sign in | English

Procedure that handles each listed file
Interrupting FTPListFile
Time-out for transfer
Internet browser

WINDEV

WEBDEV

WINDEV Mobile

Others

See also

FTPListFile (Function)

In french: FTPListeFichier

Lists the files (and/or the directories) found in a directory of an FTP server and returns the number of listed files (and/or directories)

The listed files are sought in the given directory. For each found file, FTPListFile automatically calls a specific procedure. This procedure is used to handle the current file. This procedure must return a result (True to continue to list the directories and/or the files, False to stop).

Caution: This function is not recursive. The search is performed in the specified directory, while ignoring the sub-directories.

Example

See additional examples

// Lists the .BMP files found in "/Documents" on the FTP server.
// The FileAttribute procedure returns the number of read-only files.
ResFileList = FTPListFile(7, "/Documents/*.BMP", "FileAttribute")

Syntax

<Result> = FTPListFile(<Connection identifier> , <Path and generic name of files> , <Procedure name> [, <Files/Directories> [, <Parameter>]])

<Result>: Integer

Number of listed files,
0 (if an error occurred). To find out whether an error was generated by this function, use ErrorInfo associated with the errMessage constant.

<Connection identifier>: Integer

Connection identifier, returned by FTPConnect.

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

Path and generic name of files (or directories) to list. The generic characters (* and?) are allowed. The different path sections are separated by "slashes" ("/").
If the path has the following format "/<DirectoryName>/<FileName>": The search path is "/<Directory name>/<File name>".
If the path has the following format "<DirectoryName>/<FileName>": The search path is "/<Current server directory>/<Directory name>/<File name>".

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

Name of procedure called for each listed file ("callback"). This procedure is used to handle the current file. This procedure must return a result.
To force the browse operation to stop, the procedure must return False and to continue the browse operation, the procedure MUST return True.
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 file is processed.

<Files/Directories>: Optional constant (or combination of constants)

Specifies the sought elements:
ftpFile The search is performed on the files only.
ftpDirectory The search is performed on the directories.
By default, this parameter is set to ftpFile+ftpDirectory: the search is performed on the files and directories.

<Parameter>: Type corresponding to the value passed (optional)

Parameter passed to the procedure <Procedure name>.

Remarks

Procedure that handles each listed file

For each file found, FTPListFile automatically calls the <Procedure name> procedure. This procedure is declared as follows:

PROCEDURE <Procedure Name>(<File>[, <Size> [, <Attribute> ...
[, , <Date> [. <Time> [, <Procedure parameter>]]]]])

<File>: name of file or directory used.
<Size>: optional integer corresponding to the size of file found (in bytes). This parameter must be ignored for a directory.
<Attribute>: optional character string describing the attributes of file or directory found. The format used is identical to the one of FTPAttribute.
<Date>: optional character string corresponding to the modification date of file (or directory) found. The format used is "YYYYMMDD".
<Time>: optional character string corresponding to the modification time of file (or directory) found. The format used is "HHMMSS".
<Procedure parameter>: corresponds to the value passed to the <Parameter> of FTPListFile. If <Parameter> is not specified, <Procedure parameter> is set to 0.

Caution: In the <Procedure name> procedure:

no FTP function that uses the same connection as the one used by FTPListFile must be called.
you can retrieve the properties (name, size, attributes, dates and times) of the file listed by FTPName, FTPSize, FTPAttribute, FTPDate and FTPTime. However, this solution takes a lot of time: it requires an additional request to the FTP server. Therefore, it is easier to directly read the optional parameters passed to the <Procedure name> procedure.

Interrupting FTPListFile

FTPListFile cannot be interrupted as long as files must still be browsed. To force the interruption of the browse, use the following code line in the <Procedure name> procedure:

RESULT False

In this case, FTPListFile returns the number of files 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).

Time-out for transfer

By default, all the FTP functions fail if the FTP server does not respond within 20 seconds. This time-out can be modified by FTPConnect when connecting to the FTP server.

Internet browser

FTPListFile requires Internet Explorer version 3 or later.

If a problem occurs, we recommend that you run a test with the browser by directly passing a link such as "ftp://server/...". If a problem occurs with Internet Explorer (with a UNIX server for example), use FTPCommand directly.

Related Examples:

Unit examples (WINDEV): The FTP functions

[ + ] Using the main FTP functions of WINDEV:
- Connect to a FTP server
- List the files and directories found on the FTP server
- Retrieve the files found on the FTP server
- Disconnect from a FTP server

Component : wd240com.dll