IP*Works! V9 - Online Help
IP*Works! V9
Questions / Feedback?

FTP Class

Properties   Methods   Events   Configuration Settings   Errors  

The FTP Component can be used to transfer files to and from FTP servers using the FTP Protocol.

Class Name

IPWorks_FTP

Procedural Interface

 ipworks_ftp_open();
 ipworks_ftp_close($res);
 ipworks_ftp_register_callback($res, $id, $function);
 ipworks_ftp_get_last_error($res);
 ipworks_ftp_get_last_error_code($res);
 ipworks_ftp_set($res, $id, $index, $value);
 ipworks_ftp_get($res, $id, $index);
 ipworks_ftp_do_abort($res);
 ipworks_ftp_do_append($res);
 ipworks_ftp_do_config($res, $configurationstring);
 ipworks_ftp_do_deletefile($res, $filename);
 ipworks_ftp_do_doevents($res);
 ipworks_ftp_do_download($res);
 ipworks_ftp_do_interrupt($res);
 ipworks_ftp_do_listdirectory($res);
 ipworks_ftp_do_listdirectorylong($res);
 ipworks_ftp_do_logoff($res);
 ipworks_ftp_do_logon($res);
 ipworks_ftp_do_makedirectory($res, $newdir);
 ipworks_ftp_do_removedirectory($res, $dirname);
 ipworks_ftp_do_renamefile($res, $newname);
 ipworks_ftp_do_storeunique($res);
 ipworks_ftp_do_upload($res);

Remarks

The FTP Class implements a standard FTP client as specified in RFC 959 and RFC 1579.

The first step in using the class is specifying the RemoteHost, User and Password. The file to upload to or download from is given by the RemoteFile property. The file to download to or upload from is specified by LocalFile. The current path in the server is specified by the RemotePath property. The Passive property is especially useful if the client is behind a firewall which inhibits incoming connections to higher ports.

If LocalFile is set to something other than an empty string, then files are received in LocalFile, otherwise the data is received through the Transfer event. StartTransfer and EndTransfer are fired at the beginning and end of transmission.

The PITrail event traces the interaction between the client and the server (the FTP Protocol Interface connection).

Directory listings are received through the DirList event.

Property List


The following is the full list of the properties of the class with short descriptions. Click on the links for further details.

AccountThe user account to login with.
CommandUsed to send additional commands directly to the server.
ConnectedShows whether the component is connected.
DirListCountThe number of records in the DirList arrays.
DirListEntryThis property contains the raw entry as received from the server.
DirListFileNameThis property shows the file name in the last directory listing.
DirListFileSizeThis property shows the file size in the last directory listing.
DirListFileTimeThis property shows the file time in the last directory listing.
DirListIsDirThis property specifies whether entries in the last directory listing are directories.
FileExistsReturns True if the file specified by RemoteFile exists on the remote server.
FileSizeThe size of the file pointed to by RemoteFile .
FileTimeThe last modification time of the file pointed to by RemoteFile .
FirewallAutoDetectThis property tells the component whether or not to automatically detect and use firewall system settings, if available.
FirewallTypeThis property determines the type of firewall to connect through.
FirewallHostThis property contains the name or IP address of firewall (optional).
FirewallPasswordThis property contains a password if authentication is to be used when connecting through the firewall.
FirewallPortThis property contains the TCP port for the firewall Host .
FirewallUserThis property contains a user name if authentication is to be used connecting through a firewall.
IdleThe current status of the component.
LastReplyThe last reply from the server.
LocalFileThe path to a local file for download/upload. If the file exists, it is overwritten.
LocalHostThe name of the local host or user-assigned IP interface through which connections are initiated or accepted.
OverwriteIndicates whether or not the component should overwrite files during transfer.
PassiveControls whether to direct the server into passive mode. Recommended if behind a firewall.
PasswordThe password to log in.
RemoteFileThe name of the remote file for uploading, downloading, etc.
RemoteHostThe domain name or IP address of the FTP server.
RemotePathThe current path in the FTP server.
RemotePortThe port for the FTP service (default is 21).
StartByteThe byte index in RemoteFile and LocalFile from which to start the transmission.
TimeoutA timeout for the component.
TransferModeThe transfer mode (ASCII or Binary). If the value is 0 (default), the initial server mode will be used.
UserThe user identifier to use for login.

Method List


The following is the full list of the methods of the class with short descriptions. Click on the links for further details.

AbortAbort Current Upload/Download.
AppendAppend data from LocalFile to a RemoteFile on an FTP server.
ConfigSets or retrieves a configuration setting .
DeleteFileRemove a file specified by FileName from an FTP server.
DoEventsProcesses events from the internal message queue.
DownloadDownload a RemoteFile from an FTP server.
InterruptInterrupt the current method.
ListDirectoryList the current directory specified by RemotePath on an FTP server.
ListDirectoryLongList extended directory information for RemotePath .
LogoffLogoff from the FTP server by posting a QUIT command.
LogonLogon to the FTP RemoteHost using the current User and Password .
MakeDirectoryCreate a directory on an FTP server.
RemoveDirectoryRemove a directory specified by DirName from an FTP server.
RenameFileChange the name of RemoteFile to NewName .
StoreUniqueUpload a file with a Unique Name to an FTP server.
UploadUpload a file specified by LocalFile to an FTP server.

Event List


The following is the full list of the events fired by the class with short descriptions. Click on the links for further details.

ConnectionStatusFired to indicate changes in connection state.
DirListFired when a directory entry is received.
EndTransferFired when a file completes downloading/uploading.
ErrorInformation about errors during data delivery.
PITrailTraces the commands sent to the server, and the respective replies.
StartTransferFired when a file starts downloading/uploading.
TransferFired during file download/upload.

Configuration Settings


The following is a list of configuration settings for the class with short descriptions. Click on the links for further details.

ActiveModePORTAddressAllows the specification of the PORT address value for active mode connections.
ActiveModeIPAllows the specification of the IP address that the server will connect to for active mode connections.
AppendToLocalFileAppend downloaded files to a local file.
CalculatePercentDoneEnables or Disables calculating the percent complete for downloads.
CheckTotalEntryWhether to ignore directory listing total lines.
DILingerWhen set to True, DI connections are terminated gracefully.
DILingerTimeTime in seconds to have the DI connection linger.
IgnoreEntriesDirectory entry data to ignore.
FileTimeFormatThe format of file time reported by the server.
PortRangeAllows the specification of a port range where the component listens for active mode connections.
RealTimeUploadEnables real time uploading.
RealTimeUploadAgeLimitThe age limit in seconds when using RealTimeUpload.
UseEPSVAllows extended passive mode.
UseMLSDUses listings for machine processing.
UseMLSTUses single file listing for machine processing.
UseModeZAllows compression to be used when transferring data.
ModeZCompressionLevelUsed to specify the level of compression used.
UseRemoteHostAddressForPassiveInstructs the component to use the address specified by RemoteHost when establishing a data connection.
ConnectionTimeoutSets a separate timeout value for establishing a connection.
FirewallAutoDetectTells the component whether or not to automatically detect and use firewall system settings, if available.
FirewallHostName or IP address of firewall (optional).
FirewallPasswordPassword to be used if authentication is to be used when connecting through the firewall.
FirewallPortThe TCP port for the FirewallHost;.
FirewallTypeDetermines the type of firewall to connect through.
FirewallUserA user name if authentication is to be used connecting through a firewall.
KeepAliveTimeThe inactivity time in milliseconds before a TCP keep-alive packet is sent.
KeepAliveIntervalThe retry interval, in milliseconds, to be used when a TCP keep-alive packet is sent and no response is received.
LingerWhen set to True, connections are terminated gracefully.
LingerTimeTime in seconds to have the connection linger.
LocalHostThe name of the local host through which connections are initiated or accepted.
LocalPortThe TCP port in the local host where the component binds.
MaxLineLengthThe maximum amount of data to accumulate when no EOL is found.
MaxTransferRateThe transfer rate limit in bytes per second.
RecordLengthThe length of received data records.
TCPKeepAliveDetermines whether or not the keep alive socket option is enabled.
UseIPv6Whether to use IPv6.
TcpNoDelayWhether or not to delay when sending packets.
AbsoluteTimeoutDetermines whether timeouts are inactivity timeouts or absolute timeouts.
FirewallDataUsed to send extra data to the firewall.
InBufferSizeThe size in bytes of the incoming queue of the socket.
OutBufferSizeThe size in bytes of the outgoing queue of the socket.
CodePageThe system code page used for Unicode to Multibyte translations.

 
 
Copyright (c) 2018 /n software inc. - All rights reserved.
Build 9.0.6635.0