File Transfer Protocol (FTP)


CLASS aprFTP

 

Description
The aprFTP Class allows the developer to connect to a remote server and perform file and directory maintenance functions. In addition to copying files between the local and remote host, the aprFTP Class can be used to list the files on the remote system, remove and rename files, create and remove directories and perform other server-specific functions. 

 

For Secure Edition information, see SLL Certificates.

 

Variables

 

cErr

Holds a description for the Last error code

 

Debug

Enable/Disable extended Debug notifications.

 

DebugTrace

Enable/Disable Callstack List to be included in Error Messages (:Debug)

 

nErr

Holds the last error code

 

Session

Holds the Initial Session handle value (used as the Default Session handle)

 

 

 

Methods

 

New()

Creates a new instance of the aprFTP Class

 

Destroy()

Releases the system resources assigned by the :New() Method.

 

 

 

 

Account()

Specify the client account for the current session

 

Allocate()

Allocate the specified number of bytes on the server

 

Cancel()

Cancel the current blocking operation

 

ChangeDirectory()

Change the current working directory on the server

 

ChangeDirectoryUp()

Change the current working directory on the server

 

CloseDirectory()

Close the open directory on the server

 

CloseFile()

Close the current file on the server

 

Command()

Send a command to the remote server

 

Connect()

Establish a client connection with a remote server

 

ConnectEx()

Establish a connection with the specified server, and define security-relation options to be used

 

CreateDirectory()

Create the specified directory on the server

 

Disconnect()

Disconnect the client session from the remote server

 

EndOfFile()

Determine if the end-of-file has been reached

 

FileList()

Initiate a file-listing command

 

GetBufferSize()

Return the size of an internal buffer used during data transfers

 

GetBytesCopied()

Return the number of bytes current copied

 

GetDirectory()

Get the current working directory on the remote server

 

GetDirectoryFormat()

Get the format which is used by the server to list files

 

GetFile()

Copy a file from the server to the local system

 

GetFileLength()

Return the size of a file on the server

 

GetFileMask()

Return the current file mask string

 

GetFileStatus()

Return file status information from the server

 

GetFirstFile()

Return the first file from the file list returned by the server

 

GetMultipleFiles()

Copy multiple files from the server to the local system

 

GetNextFile()

Return the next file from the file list returned by the server

 

GetProxyType()

Return the proxy type selected by the client

 

GetResultCode()

Return the result code from the previous command

 

GetResultString()

Return the result string from the previous command

 

GetSecurityInformation()

Return security information about the current client connection

 

GetSocket()

Return a handle to the command channel socket

 

GetStatus()

Return system status of remote server

 

GetSystemInfo()

Get system information about the server

 

GetTransferStatus()

Return file transfer statistics

 

GetTransferTime()

Return the amount of time to transfer the previous file

 

IsBlocking()

Determine if the current operation is blocked

 

Login()

Login to the remote server

 

Logout()

Logout from the remote server

 

MountStructure()

Mount a structure (filesystem) on the server

 

OpenDirectory()

Open the specified directory for reading

 

OpenFile()

Open the specified file for reading or writing

 

Password()

Specify the client password for the current session

 

ProxyConnect()

Establish a connection with a proxy server

 

ProxyConnectEx()

Establish a connection with an FTP proxy server, and define security-relation options to be used

 

PutFile()

Copy a file from the local system to the server

 

PutMultipleFiles()

Copy multiple files from the local system to the server

 

Read()

Read data from the server

 

RemoveDirectory()

Remove a directory from the server

 

RemoveFile()

Remove a file from the server

 

RenameFile()

Rename a file on the server

 

Reset()

Reset the client connection

 

Restart()

Restart a file transfer at the specified offset

 

SetBufferSize()

Set the size of an internal buffer used during data transfers

 

SetDirectoryFormat()

Set the format which is used by the server to list files

 

SetFileMask()

Set the current file mask

 

SetFileMode()

Set the current file mode

 

SetFileStructure()

Set the current file data structure

 

SetFileType()

Set the current file type

 

SetLastError()

Set the last error code

 

SetPassiveMode()

Set the server in passive mode

 

Timeout()

Get/Set the number of seconds until an operation times out

 

Trace()

Enable/Disable logging of socket-level calls to a file

 

Username()

Specify the user name for the current session

 

Write()

Write data to the server