Gambas Documentation - /comp/gb.net.curl/ftpclient

# FtpClient (gb.net.curl)

This class inherits Curl.
This class is
Creates a new FTP client.
creatable
.

Properties | Methods | Events
--- | --- | ---

Returns or sets whether the FTP/HTTP request will be asynchronous.
Async
Returns or sets if the stream is blocking.
Blocking
Returns or sets the byte order used to read or write binary data to the stream.
ByteOrder
Return or set the debugging mode.
Debug
Return the number of bytes that have been downloaded.
Downloaded
This property signals whether the last use of LINE INPUT reached the end of file, instead of reading a full line with an end-of-line character.
EndOfFile
Returns or sets the newline separator used by this stream.
EndOfLine
Return the error string associated with the error code returned by the curl library.
ErrorText
Returns the system file descriptor associated with this Stream.
Handle
Returns a virtual object that allows you to enumerate a stream line by line.
Lines
Return or set if the FtpClient can or cannot use EPSV when doing passive FTP downloads.
NoEPSV
Returns or sets the password used for authorization.
Password
Returns a virtual object used for defining proxy parameters.
Proxy
This virtual property allows to define the SSL properties of the CURL connection.
SSL
Returns the status of the client.
Status
Returns or sets the tag associated with the stream.
Tag
Returns or sets the client timeout in seconds.
Timeout
Returns the total number of bytes that are expected to be downloaded.
TotalDownloaded
Returns the total number of bytes that are expected to be uploaded.
TotalUploaded
Return or set the URL of the resource to download.
URL
Return the number of bytes that have been uploaded.
Uploaded
Returns or sets the user used for authorisation.
User

Start to buffer data written to the stream, so that everything will be sent when the Send method is called.
Begin
Closes the stream.
Close
Drop the data that has been buffered since the last call to the Begin method.
Drop
Execute specific FTP commands.
Exec
Retrieve a file from the FTP server.
Get
Returns the contents of the internal stream buffer.
Peek
Send a file to the FTP server.
Put
Read a line of text from the stream, like the LINE INPUT instruction.
ReadLine
Send all the data, in one shot, since the last call to Begin.
Send
Abort the current command.
Stop

This event is raised when a request has been cancelled.
Cancel
Raised when the connection is established.
Connect
Raised when there was an error returned by the CURL library.
Error
Raised when a command terminates correctly.
Finished
This event is raised periodically when something is downloaded or uploaded.
Progress
Raised when there is some data received.
Read