Class wwFTP

The FTP class provides FTP Client services for uploads and downloads as well as file listings for specific directories. The class also supports basic Event


Parent Class: wwipstuff
Stored in: wwIPStuff.vcx


Class Members

MemberDescription
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 the name, file attributes and size of the file.
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 and allows trapping the OnFTPBufferUpdate event. This event allows for status information and also cancellation of a download.
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)
FtpSetDirectory Sets the current directory for the FTP Server.
o.FtpSetDirectory(lcPath)
cftpserver Name of the FTP server to connect to
cftpsource Source file to either send or read.
cftptarget Target file to send or receive.
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.
lPassiveFTP Determines whether to use Passive FTP for FTP connections.
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.
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

Requirements

See also:

FTP Connection Troubleshooting

  Last Updated: 1/24/2008 | © West Wind Technologies, 2008