Xceed .NET Libraries Documentation
Xceed.Ftp Assembly / Xceed.Ftp Namespace / AsyncFtpClient Class / BeginGetCurrentFolder(AsyncCallback,Object) Method
Callback method to be called when the asynchronous operation is completed.
An object containing state information for this operation.


In This Topic
    BeginGetCurrentFolder(AsyncCallback,Object) Method
    In This Topic
    Begins the process of retrieving the current working folder of the FTP server. Don't forget to call EndGetCurrentFolder!
    Syntax
    'Declaration
     
    Public Function BeginGetCurrentFolder( _
       ByVal callback As AsyncCallback, _
       ByVal state As Object _
    ) As IAsyncResult
    'Usage
     
    Dim instance As AsyncFtpClient
    Dim callback As AsyncCallback
    Dim state As Object
    Dim value As IAsyncResult
     
    value = instance.BeginGetCurrentFolder(callback, state)
    public IAsyncResult BeginGetCurrentFolder( 
       AsyncCallback callback,
       object state
    )

    Parameters

    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 FTP server's current working folder is used by the FTP server as the base folder from which to perform file operations such as obtaining folder contents, receiving, sending and deleting files, changing the current folder, etc. It can be changed using the BeginChangeCurrentFolder%M:Xceed.Ftp.AsyncFtpClient.EndChangeCurrentFolder(System.IAsyncResult)% and BeginChangeToParentFolder%M:Xceed.Ftp.AsyncFtpClient.EndChangeToParentFolder(System.IAsyncResult)% methods.

    When using a callback, the System.IAsyncResult is provided as a parameter. You should call EndGetCurrentFolder in that callback. When NOT providing a callback, you should keep the returned IAsyncResult and call EndGetCurrentFolder with it when ready to complete. In this later case, the call to EndGetCurrentFolder 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