Zoople - FTP ActiveX Client API

API

Summary of the API for the FTP ActiveX library.

Properties

Username	Definition	Description
Run-time : RW	Username() As String	A valid username for FTP authentication

TransferType
Run-time : RW	TransferType () As nb_TransferType	Whether the ftp DLL uses ASCII or binary mode for file transfers

ShowDialog
Run-time : RW	ShowDialog() As Boolean	When true the DLL displays the cancelable transfer dialog during file uploads and downloads. When false no dialog is displayed. Note – the transferprogess event is still raised by the DLL for every 255 bytes of data transferred if showDialog is false.

ProxyServer
Run-time : RW	ProxyServer() As String	If a proxy server is used this is the name or IP of the proxy server.

proxyBypassList
Run-time : RW	proxyBypassList() As String	Space delimited string servers that are to bypass the proxy server. Wildcards are acceptable in this list eg inte will bypass server painter and internal.

Password
Run-time : RW	Password() As String	A valid password for FTP server authentication

Passive
Run-time : RW	Passive() As Boolean	When true the DLL uses passive transfers to and from a FTP server.

LicName
Run-time : RW	LicName() As string	Your Order ID obtained from the original website order.

LicKey
Run-time : RW	LicKey() As string	Your licence Key.

InitDir
Run-time : RW	InitDir() As string	The initial directory connected to upon successful authentication on an FTP server.

Host
Run-time : RW	Host() As string	The name or IP address of an FTP Server.

FTPPort
Run-time : RW	FTPPort() As long	The port number used. The default value is port 21.

FTPPort
Run-time : RW	FTPPort() As long	The port number used. The default value is port 21.

Directory
Run-time : R	Directory() As Directory	A collection items, both files and folders in the current directory of the FTP Server
UseLocalMachineTime	() as Boolean

Methods

Connect	Definition	Description
	Connect() as Boolean	Connects to an FTP server. Returns true on a successful connection and false if the connection attempt was not successful.

CancelTransfer
	CancelTransfer () as Boolean	Cancels the current transfer Operation

CreateDirectory
	CreateDirectory(sDirectory as string) as Boolean	Creates a new directory in the current directory on an FTP server. Returns true on success or false on failure

DeleteFile
	DeleteFile(sFilename as string) as Boolean	Deletes a file from the current directory an FTP server. Returns true on a successful deletion and false if the delete attempt was not successful.

Disconnect
	Disconnect() as Boolean	Ends the connection to an FTP server. Returns true on a successful disconnection and false if the disconnection attempt was not successful.

GetCurrentDirectory
	GetCurrentDirectory() as string	Returns a string value containing the current FTP directory name.

GetDirectoryListing

GetDirectoryListing (sFilter as string) as boolean

Refreshes the currently directory listing for the current directory. A filter string may be applied to the listing. Eg *.gif will only populate the list with files ending in ‘.gif'. *.* will list all folders and files in the directory.

The directory items may be accessed through the ftp DLL directory properties. Eg oftp.directory.items.count returns the number of files and folders in the directory matching the filter string.