Navigation: Subroutines

FTPDLX

Updated January 2024;

With A-Shell 7.0.1754, FTPDLX is officially deleted. All calls to FTPDLX are re-directed to FTP2, which see for details.

Deprecated. Replaced by FTP2, which works under both Windows and Linux and should always be used for new/current programs. FTPDLX continues to work for historical compatibility, but should not be used in any new program elements.

xcall FTPDLX, host, user, password, localpath, hostfile, hostdir, opcode, status {, port, emsg, privkey, passphrase}

(Windows only) FTPDLX sends and sends and receives files via FTP or SFTP protocol.

Parameters

host  (String)  [in]

Specifies the name or IP address of the HOST computer you want to send files to or receive files from.

user  (String)  [in]

Specifies the user login name for the remote HOST. For anonymous FTP, use "anonymous"

password  (String)  [in]

Specifies the login password. For anonymous FTP, use your email address (e.g. myname@mydoman.com)

localpath  (String)  [in]

Full pathspec (PC format) for the local file (whether sending or receiving.) If no directory specified, the current login directory will be used. Note: you may want to use MIAMEX, MX_FSPEC to translate an AMOS directory specification to a PC version. See Comments below for wildcarding.

hostfile  (String)  [in]

May be the full pathspec of the remote file, or just the filename and extension. In the former case, leave HOSTDIR blank, otherwise specify the directory in HOSTDIR. HOSTFILE is case sensitive. See Comments below for wildcarding.

hostdir  (String)  [in]

If not blank, it is prepended to the hostfile field to form the full pathspec of the remote file. hostdir is case sensitive.

opcode  (Num)  [in]

Note that while most of the codes apply to both FTPDLX and FTP2, some apply—as indicated—only to one or the other.

 

status  (F,6)  [out]

*Return status. 0=success. Negative numbers are internal errors in FTPDLXcall which you can see from the source code and which are listed in the table below. -1 indicates a user abort. Numbers 1000 and up are EZFTP.OCX errors.

port  (Num)  [in]

Specifies the control port to connect to the FTP server on. Default is 21 for FTP and 22 for SFTP.

emsg  (String)  [out]

May return a message on error.

privkey  (String)  [in])

contains the filespec of private key file in OpenSSH format. If specified and non-blank, FTPDLX will use public/private key authentication rather than standard password authentication.

passphrase (String)  [in]

is the passphrase for the private key. May be omitted if the private key is not passphrase-protected.

 

Comments

ALIAS=FTPDLX:FtpDLXcall.FTP

It relies on two dlls: FTPDLXcall2.dll and wodFtpDLX.dll, both of which are normally stored in the %miame%\bin directory, and both of which must be registered using regsvr32.exe. The ALIAS, dlls, and registration are handled automatically by a typical installation, but might require a manual assist if the installation was set up manually using COPY commands rather than the installer.

Environmental Notes

FTPDLX is based on a commercial COM FTP control called wodFTPDLX by WeOnlyDo Controls, the runtime license for which is included with A-Shell.

FTPDLX relies on two DLLs, wodFTPDLX and FTPDLXcall, being in the bin directory (where ashw32.exe is loaded from), and it requires the following miame.ini setting:

ALIAS=FTPDLX:FTPDLXcall.FTP

FTPDLX is used internally by ATE to implement the AG_FTP and ZTERM file transfer escape sequence. See also:

History

2015 April, A-Shell 6.1.1406:  Added FTP/SFTP remote delete.

2014 May, A-Shell 6.1.1385:  Add parameters privkey and passphrase.

2014 February, A-Shell 6.1.1379:  Rewrote opcode table to add new options for FPT2 and to improve clarity.

Negative Error Codes Returned in status