Search: 
Available in: EDI/AS2 | IP*WORKS! | SSL
FTP Component [IP*Works! V8]

Properties   Methods   Events   Configuration Settings  

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

NOTE: What follows is a very short description of the component interfaces. For more information, please consult the help files that come with the respective package.

Remarks

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

The first step in using the component 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 component with short descriptions. Click on the links for further details.

AccountThe user Account to login with.
CommandCan be used to send additional commands directly to the server.
ConnectedShows whether the component is connected.
DirListCollection of entries resulting in the last directory listing.
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.
FirewallA set of properties related to firewall access.
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.
OverwriteWhether 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 login with.
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 id to login as.

Method List


The following is the full list of the methods of the component 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.
SetDownloadStreamSets the stream to which the downloaded data from the server will be written.
SetUploadStreamSets the stream from which the component will read data to upload to the server.
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 component 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 component with short descriptions. Click on the links for further details.

ActiveModePORTAddressAllows the specification of the PORT address value for active mode connections
CalculatePercentDoneEnables or Disables calculating the percent complete for downloads
MaxDirEntriesInstructs component to save the amount of entries specified that are returned by the server after a ListDirectory call has been made
PortRangeAllows the specification of a port range where the component listens for active mode connections
UseEPSVAllows extended passive mode
UseRemoteHostAddressForPassiveInstructs component to use the RemoteHost in passive mode
MaxLineLengthThe maximum amount of data to accumulate when no EOL is found
FirewallAutoDetectTells the component whether or not to automatically detect and use firewall system settings, if available
FirewallHostName or IP address of firewall (optional)
FirewallListenerIf true, the component binds to a SOCKS firewall as a server (IPPort only)
FirewallPasswordPassword to be used if authentication is to be used when connecting through the firewall
FirewallPortThe TCP port for the FirewallHost;
FirewallUserA user name if authentication is to be used connecting through a firewall
FirewallTypeDetermines the type of firewall to connect through
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 (Windows/COM only)

| About | Privacy Policy | Terms of Use |
© Copyright 2010 /n software inc.