Class wwFtp (deprecated)
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… |
|
FtpGetFileEx | Retrieves a file from an FTP site a Retrieves a file from an FTP site and allows trapping the OnFTPBufferUpdate event. This event allows for status information and also cancellation of a download.
o.FtpGetFileEx(lcSourceFile, lcTargetFile)
|
|
|
FtpSetDirectory | Sets the current directory for the FTP Server.
o.FtpSetDirectory(lcPath)
|
|
|
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. If you want to get a response from the FTP server you have to pass in a buffer parameter that will be able to hold the result from…
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…
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)
|
|
|
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. This method operates in blocking mode waiting for completion of the file transfer before returning a result code.…
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. Works better for small…
o.FtpSendFileEx2(lcSourceFile, lcTargetFile)
|
|
|
aFTPDir | This method retrieves a directory listing from an FTP directory into an array. The array returns: * File name * File Size * File attributes (16 - Directory, 128 - File) * File DateTime
o.aFTPDir(@aFiles,cFileSpec)
|
|
hftpsession | The FTP Session handle used in Internet Access. One of two (hIPSession is the other) |
|
|
lcanceldownload | Cancel flag that can be set in OnFTPBufferUpdate to let wwFTP know to stop downloading a file from the Internet. |
|
|
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. |
|
|
lPassiveFTP | Determines whether to use Passive FTP for FTP connections. Some FTP Servers require passive FTP, so if you have problems connecting to your FTP server or transferring files you can try this flag to… |
|
|
nFtpPort | Sets the FTP port used by this instance of wwFTP. Default is the default FTP port of 21. This port is misnamed due to some compatibility issues. |
|
|
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 |
|
|
cftpserver | Name of the FTP server to connect to |
|
|
cftpsource | Source file to either send or read. |
|
|
cftptarget | Target file to send or receive. |
|
|
nftpbinary | Flag to determine whether FTP file sent is ASCII (0) or Binary (1) |
|
|
cErrorMsg | An error message if the method called previously failed. |
|
|
cftpserver | The FTP server to connect to. |
|
|
cftpsource | The Source file to upload from the client or download from the server. |
|
|
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. Note the proxy needs to be specified using full HTTP syntax (http://DomainNameorIp:port) in order to work.… |
|
|
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. |
|
|
hIPSession | Internally used handle for the Internet connection. |
|
|
nConnectTimeout | Connection timeout |
|
|
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) |
|
|
nHttpConnectType | Determines the connection mode for the FTP connection Connection modes: * 0 - Auto configuration (from system IE settings) *default * 1 - direct * 3 - Proxy |
|
|
nServiceFlags | Any WinInet service flags to be applied to the FTP connection. |
Assembly: wwftp.prg
Comment or report problem with topic