WebFtpPutFile Function

Action

Stores a file on the FTP server.

Include file

WebAPI.bdh

Syntax

WebFtpPutFile( in hFtp            : number, 
               in sLocalFile      : string, 
               in sRemoteFile     : string, 
               in bBinaryTransfer : boolean ): boolean;

Return value

  • true if successful

  • false otherwise

Parameter Description
hFtp Valid handle to an FTP session
sLocalFile String that contains the name of the file to send from the local system
sRemoteFile String that contains the name of the file to create on the remote system. Can be either partially or fully qualified file name relative to the current directory. A backslash (\) or forward slash (/) can be used as the directory separator for either name. WebFtpPutFile translates the directory name separators to the appropriate character before they are used.
bBinaryTransfer

If this parameter is set to true, WebGetFile transfers the file using FTP's Image (Type I) transfer method. The file is transferred exactly as it exists with no changes. This is the default transfer method.

If this parameter is set to false, FTP's ASCII (Type A) transfer method is used. Control and formatting information is converted to local equivalents.

Example

// Store a file on the FTP server. 
dcltrans 
  transaction TWebFtpDir 
  var
    hFtp: number; 
  begin
    WebFtpConnect(hFtp, "standardhost", WEB_PORT_FTP, 
                     "anonymous", "mymail@address.com"); 
    WebFtpPutFile(hFtp, "perfrep1.qrp", "test_file.txt", false);
    WebFtpShutdown(hFtp); 
  end TWebFtpDir;

SilkEssential sample

Ftp.sep