Xceed .NET Libraries Documentation
Xceed.Ftp Assembly / Xceed.Ftp Namespace / AsyncFtpClient Class / BeginSendFile Method / BeginSendFile(String,String,AsyncCallback,Object) Method
The path and filename of the local file to send.
The filename as it will be stored on the FTP server. Some FTP servers may be case-sensitive!
Callback method to be called when the asynchronous operation is completed.
An object containing state information for this operation.


In This Topic
    BeginSendFile(String,String,AsyncCallback,Object) Method
    In This Topic
    Begins the process of sending the specified file to the FTP server's current working folder and stores it using the specified filename. Don't forget to call EndSendFile!
    Syntax
    'Declaration
     
    Public Overloads Function BeginSendFile( _
       ByVal localFilename As String, _
       ByVal remoteFilename As String, _
       ByVal callback As AsyncCallback, _
       ByVal state As Object _
    ) As IAsyncResult
    'Usage
     
    Dim instance As AsyncFtpClient
    Dim localFilename As String
    Dim remoteFilename As String
    Dim callback As AsyncCallback
    Dim state As Object
    Dim value As IAsyncResult
     
    value = instance.BeginSendFile(localFilename, remoteFilename, callback, state)
    public IAsyncResult BeginSendFile( 
       string localFilename,
       string remoteFilename,
       AsyncCallback callback,
       object state
    )

    Parameters

    localFilename
    The path and filename of the local file to send.
    remoteFilename
    The filename as it will be stored on the FTP server. Some FTP servers may be case-sensitive!
    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

    By default, the file will be sent to the current working folder. 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. Absolute paths can also be provided, however some FTP servers might not support absolute paths and different server types may have different ways of representing absolute paths.

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

    If the remote file already exists, it will be overwritten.

    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