Xceed .NET Libraries Documentation
BeginSendFile(String,Boolean,AsyncCallback,Object) Method


Xceed.Ftp Assembly > Xceed.Ftp Namespace > AsyncFtpClient Class > BeginSendFile Method : BeginSendFile(String,Boolean,AsyncCallback,Object) Method
The path and filename of the local file to send.
true if the file should append itself to the remote file if it already exists; false if the remote file should be overwritten.
Callback method to be called when the asynchronous operation is completed.
An object containing state information for this operation.
Begins the process of sending the specified file to the FTP server's current working folder using the same filename and indicating if it should append itself to the remote file if it already exists. Don't forget to call EndSendFile!
Syntax
'Declaration
 
Public Overloads Function BeginSendFile( _

   ByVal localFilename As String, _

   ByVal append As Boolean, _

   ByVal callback As AsyncCallback, _

   ByVal state As Object _

) As IAsyncResult
'Usage
 
Dim instance As AsyncFtpClient

Dim localFilename As String

Dim append As Boolean

Dim callback As AsyncCallback

Dim state As Object

Dim value As IAsyncResult

 

value = instance.BeginSendFile(localFilename, append, callback, state)
public IAsyncResult BeginSendFile( 

   string localFilename,

   bool append,

   AsyncCallback callback,

   object state

)

Parameters

localFilename
The path and filename of the local file to send.
append
true if the file should append itself to the remote file if it already exists; false if the remote file should be overwritten.
callback
Callback method to be called when the asynchronous operation is completed.
state
An object containing state information for this operation.

Return Value

An System.IAsyncResult representing the status of the asynchronous operation.
Remarks

The file will be sent to the current working folder, using the same filename. If you want to send the file to another location, you could use the BeginChangeCurrentFolder%M:Xceed.Ftp.AsyncFtpClient.EndChangeCurrentFolder(System.IAsyncResult)% methods and/or BeginChangeToParentFolder%M:Xceed.Ftp.AsyncFtpClient.EndChangeToParentFolder(System.IAsyncResult)% methods to change the current working folder.

The current working folder can be retrieved via the BeginGetCurrentFolder%M:Xceed.Ftp.AsyncFtpClient.EndGetCurrentFolder(System.IAsyncResult)% methods.

When using a callback, the System.IAsyncResult is provided as a parameter. You should call EndSendFile in that callback. When NOT providing a callback, you should keep the returned IAsyncResult and call EndSendFile with it when ready to complete. In this later case, the call to EndSendFile may block until the operation completes.

Requirements

Target Platforms: Windows 7, Windows Vista SP1 or later, Windows XP SP3, Windows Server 2008 (Server Core not supported), Windows Server 2008 R2 (Server Core supported with SP1 or later), Windows Server 2003 SP2

See Also

Reference

AsyncFtpClient Class
AsyncFtpClient Members
Overload List