FTP Documentation

Download Add to Cart

Easy FTP ActiveX Component : Interface Definition




General Information

Library: nBitFTP (nBitFTP component)

File: nBitFTP.dll

Version: 2.3

clsDirectoryItem

Properties

clsFTP 

Methods

Function GetDirectoryListing(ByVal sFilter As String) As Boolean
Creates a directory listing object that can be obtained by querying the Directory Property

Function Disconnect() As Boolean
Disconnects from the FTP Server

Function GetRemoteFileSize(ByVal sFile As String) As Long
Returns the size of a remote file in bytes

Function GetFileProgress(ByVal sLocal As String, ByVal sRemote As String) As Boolean
Retreives a file from a remote FTP Server, displaying an optional progress dialog

Function PutFileProgress(ByVal sRemote As String, ByVal sLocal As String) As Boolean
Sends a file to a remote FTP server, displaying an optional progress dialog

Function Connect() As Boolean
Opens a connection to a remote FTP Server

Function GetCurrDirectory() As String
Returns the FTP session's current remote directory

Function SetCurrDirectory(ByVal sDir As String) As Boolean
Sets the FTP session's current remote directory

Function DeleteFile(ByVal sRemote As String) As Boolean
Deletes a file from a remote FTP Server

Function CreateDirectory(ByVal sDirectory As String) As Boolean
Creates a directory on the FTP Server

Function RemoveDirectory(ByVal sDirectory As String) As Boolean
Removes a directory from the FTP Server

Function RenameFile(ByVal sExisting As String, ByVal sNewName As String) As Boolean
Renames a file on the FTP Server

Properties

Property Get Directory(pattern as string) As _clsDirectoryList
Returns an object of the type clsDirectoryList. A collection of objects of the type clsDirectoryItem

eg oftp.getdirectory("*.jpg") returns a list of all jpg files

Property Let Passive(RHS As Boolean)
Sets the file transfer method to Passive=True or not Passive=False

Property Get Passive() As Boolean
Returns the current Setting for file transfers

Property Let InitDir(RHS As String)
Sets the initial directory that will be used upon connection to the FTP server

Property Get InitDir() As String
Returns the initial directory that will be used upon connection to the FTP server

Property Let Host(RHS As String)
Sets the Host name of the FTP Server

Property Get Host() As String
Returns the Host name of the FTP Server

Property Let FTPPort(portNumber As Long)
Sets the Port number of the FTP Server

Property Get FTPPort() As Long
Returns the Port number of the FTP Server

Property Let Password(RHS As String)
Sets the users password for the FTP Server

Property Get Password() As String
Returns the users password for the FTP Server

Property Let LicName(RHS As String)
Sets the licence name for EasyFTP

Property Let LicKey(RHS As String)
Returns the licence name for EasyFTP

Property Let UserName(RHS As String)
Sets the Username for the FTP Server

Property Get UserName() As String
Returns the Username for the FTP Server

Property Let ShowDialog(RHS As Boolean)
Show the file transfer progess dialog when transfering files

Property Get ShowDialog() As Boolean
Returns the current file transfer progess dialog setting used when transfering files

Property Get/Let UseLocalMachineTime() as Boolean
Prevents the translation of remote file creation / modification time to a time and date based on your local machine time zone settings

Events

Public Event TransferProgress(ByVal lCurrentBytes As Long, ByVal lTotalBytes As Long)
Raised every 255 bytes of file transfer

Public Event Cancelled
Raised when the user interrupts the current transfer

Public Event FTPError(ByVal ErrorNumber As Long, ByVal Description As String)

Public Event Connected
Raised upon successful connection to the FTP Server

Public Event Disconnected
Raised upon successful disconnection from the FTP Server

Public Event GetPutSuccess
Raised upon successful file transfer
























 

 

 

 

 

Download Add to Cart