FTP Documentation2

Download Add to Cart

Easy FTP ActiveX Component : Interface Definition




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.

Returns true on success or false on failure.

GetFileProgress

 

 

 

GetFileProgress (sLocal as string, sRemote as string) as boolean

Gets a file from a FTP server. sLocal is a fully qualified pathname on the local computer and sRemote is the name of file in the current FTP server directory.

Returns true on success or false on failure.

The TransferProgress event is fired for every 255 bytes of data transferred.

GetRemoteFileSize

 

 

 

GetRemoteFileSize (sFilename as string) as long

Returns the size in bytes of a file, specified by sFilename on a FTP server.

PutFileProgress

 

 

 

PutFileProgress (sRemote as string, sLocal as string) as boolean

Puts a file to a FTP server. sLocal is a fully qualified pathname on the local computer and sRemote is the name of file in the current FTP server directory.

Returns true on success or false on failure.

The TransferProgress event is fired for every 255 bytes of data transferred.


RemoveDirectory

 

 

 

RemoveDirectory (sDirectoryname as string) as Boolean

Removes a directory on a FTP server. Note – the resource specified by sDirectoryname must be a directory and must not contain any files or sub-directories.

Returns true on success or false on failure.

RenameFile

 

 

 

RenameFile (sExisting as string, sNewName as string) as Boolean

Renames an existing file on a FTP server.

Returns true on success or false on failure.

SetCurrentDirectory

 

 

 

SetCurrentDirectory (sDir as string) as Boolean

Changes the current directory on a FTP server. sDir is the name of directory in the current directory, use setcurrentdirectory(“..”) to go up one folder in the directory tree.

Returns true on success or false on failure.


Events

Cancelled

 

 

 

Cancelled()

Raised when the user clicks the cancel button of the file transfer progress dialog

Connected

 

 

 

Connected()

Raised on successful connection to a FTP server.

Disconnected

 

 

 

Disconnected ()

Raised on disconnection from a FTP server.

GetPutSuccess

 

 

 

GetPutSuccess ()

Raised on a successful file download or upload

TransferProgress

 

 

 

TransferProgress (lCurrentBytes as long, lTotalBytes as long)

Raised every 255 bytes of data transferred during getFileFTP and putFileFTP.

FTPError

 

 

 

FTPError(ErrorNumber As Long, Description As String)

FTP Error Handler


FTPEvent

 

 

 

FTPEvent (EventNumber As Long, Description As String)

Generic Event Handler

Event Number

Description

1

connected to server

2

Disconnected from server Failed

100

Got Remote File Size

101

File downloaded

102

File uploaded

103

remote file deleted

1000

File Listing Completed

1001

Got current remote directory name

1002

set current remote directory

1003

remote directory created

1004

remote directory deleted

Enumerations
nb_TransferType

Definition

Description

 

Public Enum nb_TransferType

nb_ASCII= &h3

nb_Binary = &H0

nb_Unknown =&H0

End Enum

Mode used for file transfers. Default is binary transfer



 

 

 

 

Download Add to Cart