Please use the wwFtpClient Class instead.
Provides FTP functionality for uploading and downloading files from an FTP site.
Supports authentication, proxy configuration, directory navigation and the ability to manage directories on the remote FTP site.
Remarks
This class does not support SFTP (secure FTP over SSL)
Class Members
Member | Description | |
---|---|---|
onftpbufferupdate |
Event that fires whenever the buffer is updated by FTPGetFileEx(). This method is passed the current download total and the number of chunks retrieved already. You can set lCancelDownload to .T. to force FTPGetEx to stop the file download. | |
aFTPDir |
This method retrieves a directory listing from an FTP directory into an array. The array returns: o.aFTPDir(@aFiles,cFileSpec) |
|
FtpClose |
Closes a connection with an FTP Site. This method is called automatically when the object goes out of scope. o.ftpclose() |
|
FtpCommand |
This method allows you to execute FTP commands against the server. o.FTPCommand(lcCommand, lcBuffer, lnSize) |
|
FtpConnect |
Connects to an FTP site and allows passing of a user name and password. Any FTPConnect calls should be balanced by a matching call to FTPClose. FTPClose is called automatically when the object goes out of scope. o.ftpconnect(lcServer, lcUsername, lcPassword) |
|
FtpCreateDirectory |
Creates a new directory on the FTP server. You have to use FTPConnect first to establish a connection to the server. o.FTPCreateDirectory(cPath) |
|
FTPDeleteFile |
Deletes a file on the FTP server. o.FTPDeleteFile(cFileName) |
|
FtpGetFile |
Simple FTP retrieval method. This method retrieves a file from an FTP server with a single method call. This method is synchronous and does not fire any events. o.FTPGetFile(cServer,cSourceFile,cTargetFile,nBinary,cUsername,cPassword) |
|
FtpGetFileEx |
Retrieves a file from an FTP site a o.FtpGetFileEx(lcSourceFile, lcTargetFile) |
|
FTPRemoveDirectory |
Removes a directory on the FTP server. You have to use FTPConnect first to establish a connection to the server. o.FTPRemoveDirectory(cPath) |
|
FTPRenameFile |
Renames a file on the server o.FTPRenameFile(lcOldName, lcNewName) |
|
FTPSendFile |
This method sends a file to an FTP server by connecting, sending and disconnecting. o.FTPSendFile(cServer,cSource,cTarget,cUsername,cPassword) |
|
FtpSendFileEx |
Uploads a file to an FTP site with event progress information and the ability to cancel. o.FtpSendFileEx(lcSourceFile, lcTargetFile) |
|
FtpSendFileEx2 |
Uploads a file to an FTP site. Works the same as FtpSendFileEx() except it uses a single WinInet PutFile() operation and doesn't provide individual file progress information. o.FtpSendFileEx2(lcSourceFile, lcTargetFile) |
|
FtpSetDirectory |
Sets the current directory for the FTP Server. o.FtpSetDirectory(lcPath) |
|
cErrorMsg |
An error message if the method called previously failed. | |
cftpserver |
Name of the FTP server to connect to | |
cftpserver |
The FTP server to connect to. | |
cftpsource |
Source file to either send or read. | |
cftpsource |
The Source file to upload from the client or download from the server. | |
cftptarget |
Target file to send or receive. | |
cftptarget |
The file to download to from the server or upload to on the server. | |
cHttpProxyByPass |
||
cHttpProxyName |
A proxy IP address/domain name and port address that specifies the location of the proxy. | |
cHttpProxyPassword |
Password to access the proxy specified in HttpProxyName | |
cHttpProxyUsername |
Username to access the proxy specified in HttpProxyName | |
cPassword |
Password to access the FTP site. | |
cserver |
IP Address or domain name of the server to connect to. | |
cUserAgent |
||
cUsername |
Username to access the FTP site. | |
hftpsession |
The FTP Session handle used in Internet Access. One of two (hIPSession is the other) | |
hIPSession |
Internally used handle for the Internet connection. | |
lcanceldownload |
Cancel flag that can be set in OnFTPBufferUpdate to let wwFTP know to stop downloading a file from the Internet. | |
lPassiveFTP |
Determines whether to use Passive FTP for FTP connections. | |
nConnectTimeout |
Connection timeout | |
nCurrentFileSize |
Holds the size of the file currently being downloaded or uploaded. This value is set at the start of the of FTPGetFileEx and FTPSendFileEx and is only applied to those methods. | |
nError |
Error code set on the last method that was called, if the method fails. | |
nftpbinary |
Flag to determine whether FTP file sent is ASCII (0) or Binary (1) | |
nftpbinary |
Flag to determine whether FTP file sent is ASCII (0) or Binary (1) | |
nFtpPort |
Sets the FTP port used by this instance of wwFTP. Default is the default FTP port of 21. | |
nftpworkbuffersize |
The size of the FTPGetEx download buffer. For each buffer chunk the OnFTPBufferUpdate event is fired to allow you to cancel and display status information | |
nHttpConnectType |
Determines the connection mode for the FTP connection | |
nServiceFlags |
Any WinInet service flags to be applied to the FTP connection. |
Requirements
Assembly: wwftp.prg© West Wind Technologies, 2024 • Updated: 05/26/24
Comment or report problem with topic