Difference between revisions of "TFtpClient"

From Overbyte
Jump to navigation Jump to search
 
 
(9 intermediate revisions by 3 users not shown)
Line 1: Line 1:
[[Main_Page | Main page]] -> [[ICS_Components_Reference | ICS components reference]]  
+
[[Main_Page | Main page]] -> [[ICS_Components_Reference | ICS components reference]] -> [[TFtpClient]]
-> [[TFtpClient]]
 
 
== Overview ==
 
== Overview ==
  
*'''unit''' FtpCli.pas
+
*'''unit''' [[OverbyteIcsFtpCli.pas|OverbyteIcsFtpCli.pas]]
*'''inheritance''' TFtpClient - TComponent
+
*'''inheritance''' TIcsWndControl -> TCustomFtpCli -> TFtpClient
  
 
TFtpClient component is implementing the client side FTP protocol described in RFC [http://rfc.net/rfc959.html 959]. FTP protocol is the standard protocol for transfering files.
 
TFtpClient component is implementing the client side FTP protocol described in RFC [http://rfc.net/rfc959.html 959]. FTP protocol is the standard protocol for transfering files.
Line 11: Line 10:
  
 
{|
 
{|
| valign="top" width="150" | [[TFtpClient.Handle | Handle]] |||| Handle for underlaying hidden window.
+
| valign="top" width="150" | [[TFtpClient.Binary | Binary]] |||| Used to set file transfer to be either binary or ASCII.<br>''Must call TypeSet or TypeSetAsync to activate''.
 +
|-
 +
| valign="top" | [[TFtpClient.Handle | Handle]] |||| Handle for underlaying hidden window.
 +
|-
 +
| valign="top" | [[TFtpClient.HostDirName | HostDirName]] |||| Server folder name.
 +
|-
 +
| valign="top" | [[TFtpClient.HostFileName | HostFileName]] |||| Name of the file on the server.
 +
|-
 +
| valign="top" | [[TFtpClient.HostName | HostName]] |||| Server name or IP address of the server to connect.
 +
|-
 +
| valign="top" | [[TFtpClient.LocalAddr | LocalAddr]] |||| Bind to this IP address when connecting.
 +
|-
 +
| valign="top" | [[TFtpClient.LocalFileName | LocalFileName]] |||| Name of the file on the local PC.
 +
|-
 +
| valign="top" | [[TFtpClient.PassWord | PassWord]] |||| Password for login if required.
 +
|-
 +
| valign="top" | [[TFtpClient.Port | Port]] |||| IP port of the server to connect.
 +
|-
 +
| valign="top" | [[TFtpClient.TimeOut | TimeOut]] |||| Command timeout setting.
 +
|-
 +
| valign="top" | [[TFtpClient.UserName | UserName]] |||| User's login name.
 
|}
 
|}
  
Line 17: Line 36:
  
 
{|
 
{|
| valign="top" width="150" | [[TFtpClient.Abort | Abort]] |||| Abort the current operation.
+
| valign="top" width="150" | [[TFtpClient.Abort | Abort]] |||| Abort the current operation and drops the connection.
 +
|-
 +
| valign="top" | [[TFtpClient.AbortAsync | AbortAsync]] |||| Abort the current operation and drops the connection (non-blocking).
 +
|-
 +
| valign="top" | [[TFtpClient.AbortXfer | AbortXfer]] |||| Abort the current file transfer but does not close the connection.
 +
|-
 +
| valign="top" | [[TFtpClient.AbortXferAsync | AbortXferAsync]] |||| Abort the current file transfer but does not close the connection (non-blocking).
 +
|-
 +
| valign="top" | [[TFtpClient.DirectoryAsync| DirectoryAsync]] |||| An "all-in-one" command. It calls Open, User, Pass, Pasv, Cwd, List and Quit commands.
 +
|-
 +
| valign="top" | [[TFtpClient.Quit | Quit]] |||| Closes the connection from the server.
 +
|-
 +
| valign="top" | [[TFtpClient.QuitAsync | QuitAsync]] |||| Closes the connection from the server (non-blocking).
 
|}
 
|}
  
Line 24: Line 55:
 
{|
 
{|
 
| [[TFtpClient.OnRequestDone | OnRequestDone]] |||| Triggered when a request is completed.
 
| [[TFtpClient.OnRequestDone | OnRequestDone]] |||| Triggered when a request is completed.
 +
|}
 +
{|
 +
| [[TFtpClient.OnProgress | OnProgress]] |||| Returns the progress on the transfer.
 
|}
 
|}
  

Latest revision as of 12:20, 18 March 2016

Main page -> ICS components reference -> TFtpClient

Overview

TFtpClient component is implementing the client side FTP protocol described in RFC 959. FTP protocol is the standard protocol for transfering files.

Properties

Binary Used to set file transfer to be either binary or ASCII.
Must call TypeSet or TypeSetAsync to activate.
Handle Handle for underlaying hidden window.
HostDirName Server folder name.
HostFileName Name of the file on the server.
HostName Server name or IP address of the server to connect.
LocalAddr Bind to this IP address when connecting.
LocalFileName Name of the file on the local PC.
PassWord Password for login if required.
Port IP port of the server to connect.
TimeOut Command timeout setting.
UserName User's login name.

Methods

Abort Abort the current operation and drops the connection.
AbortAsync Abort the current operation and drops the connection (non-blocking).
AbortXfer Abort the current file transfer but does not close the connection.
AbortXferAsync Abort the current file transfer but does not close the connection (non-blocking).
DirectoryAsync An "all-in-one" command. It calls Open, User, Pass, Pasv, Cwd, List and Quit commands.
Quit Closes the connection from the server.
QuitAsync Closes the connection from the server (non-blocking).

Events

OnRequestDone Triggered when a request is completed.
OnProgress Returns the progress on the transfer.

How to

How to implement a timeout for TFtpCli in my application?



ICS Components Reference