FTPSend (Function)

ONLINE HELP
WINDEV, WEBDEV AND WINDEV MOBILE

Version:

Home | Sign in | English

Help

WLanguage

WLanguage functions

Communication

FTP functions

WLanguage procedure

FTPSend

Presentation

Example

Managing the progress of the transfer

Transfer timeout

Rights of users

Relative and absolute path

Required permissions

See also

FTPSend (Function)

In french: FTPEnvoie

Transfers a file or directory to an FTP server (File Transfer Protocol).

Transfer a file or a directory found on the server hosting the application to an FTP server (File Transfer Protocol).

Example

See additional examples

// Transfer the "C:\MyDocuments\File.DOC" file
// into the "/Temp" directory on the FTP server
ResSend = FTPSend(ConnectionNum, "C:\MyDocuments\File.DOC", "/Temp")

// Transfer the "File.DOC" file found in
// the _WEB directory of the application
// to the"/Temp" directory on the FTP server
ResSend = FTPSend(ConnectionNum, fWebDir() + "\File.DOC", "/Temp")

Syntax

<Result> = FTPSend(<Connection identifier> , <File/Directory to Transfer> , <Destination file/directory> [, <WLanguage procedure> [, <Transfer mode>]])

<Result>: Boolean

True if the transfer was performed,
False otherwise. The error status report is returned by ErrorInfo.

<Connection identifier>: Integer

Connection identifier, returned by FTPConnect.
This parameter is a Variant parameter.

<File/Directory to Transfer>: Character string

Name and full (or relative) path of the file (or directory) to transfer. A UNC path can be used. No wildcard character can be used (* or?).
If this parameter corresponds to a directory, all the files found in this directory are transferred. A directory with the same name is created on the FTP server at the location specified by <Destination File/Directory>.
If this parameter corresponds to a file:
If <Destination File/Directory> is a directory found on the FTP server, the file to retrieve is copied into the destination directory.
If <Destination File/Directory> is a file found on the FTP server, the file to transfer is copied and renamed.

<Destination file/directory>: Character string

Name and full (or relative) path of destination file (or directory). This file (or directory) is found on the FTP server. The different path sections are separated by "slashes" ("/").
A full path has the following format: "/<DirectoryName>/<FileName>". The tree structure has the following format: "/<DirectoryName>/<FileName>".
A relative path has the following format: "<DirectoryName>/<FileName>". The tree structure has the following format: "/<CurrentServerDirectory>/<DirectoryName>/<FileName>".

<WLanguage procedure>: Procedure name

Name of procedure automatically called to check the transfer progress.
This parameter is not available.

<Transfer mode>: Optional Integer constant

Transfer mode used:
ftpASCIIMode Transfer performed in ASCII mode. This mode is used to transfer data between two different types of operating systems, from UNIX to Windows for example: the transferred file is changed into the ASCII format of destination system.
ftpBinaryMode
(Default value) Transfer performed in binary mode: The file is strictly identical between the sending and the receiving.

Remarks

Managing the progress of the transfer

FTPSend is a blocking function: no other action can be performed until the end of current transfer. To check the progress of the transfer, FTPSend can automatically call the <Procedure name> procedure at regular intervals.

This procedure is declared as follows:

PROCEDURE <Procedure name>(<Total size>, <Transferred size>)

<Total size> is an integer corresponding to the total size of file or directory currently transferred.
<Transferred size> is an integer corresponding to the number of bytes already transferred.

For example, you can:

display a progress bar,
find out whether the transfer is completed (<Total size> = <Transferred size>).

FTPSend cannot be interrupted as long as all files have not been transferred. To force the interruption of the browse, use the following line of code in the <Procedure name> procedure:

RESULT False

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

An error is generated if no value (neither True nor False) is returned by the <Procedure name> procedure.

Transfer timeout

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

Rights of users

Only a user who has write rights on the FTP server can send files to an FTP server. In most cases, no write rights are granted to the "anonymous" users.

Relative and absolute path

The notions of relative path and absolute path are very important in an FTP application.

A path starting with a slash is considered as being an absolute path: it is the path in relation to the root of the FTP server (parameter specific to the server).
ex: /ad/user/JULIA
A path not starting with a slash is considered as being a relative path, which means a path given in relation to the current directory. This current directory can be returned or modified by FTPCurrentDir.

When connecting to an FTP site, the initial directory (the "home directory" of the user) is not necessarily found at the root of the FTP server. Therefore, we recommend that you use relative paths.

Required permissions

The call to this function modifies the permissions required by the application.
Required permission : INTERNET
This permission allows the applications to open the network sockets.

Business / UI classification: Business Logic

Component: wd280com.dll