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


Xceed.Ftp Assembly > Xceed.Ftp Namespace > AsyncFtpClient Class : BeginChangeCurrentFolder(String,AsyncCallback,Object) Method
The new current working folder. 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.
Begins the process of changing the current working folder of the FTP server. Don't forget to call EndChangeCurrentFolder!
Syntax
'Declaration
 
Public Function BeginChangeCurrentFolder( _

   ByVal folder As String, _

   ByVal callback As AsyncCallback, _

   ByVal state As Object _

) As IAsyncResult
'Usage
 
Dim instance As AsyncFtpClient

Dim folder As String

Dim callback As AsyncCallback

Dim state As Object

Dim value As IAsyncResult

 

value = instance.BeginChangeCurrentFolder(folder, callback, state)
public IAsyncResult BeginChangeCurrentFolder( 

   string folder,

   AsyncCallback callback,

   object state

)

Parameters

folder
The new current working folder. 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

Both relative and absolute paths can be provided to the BeginChangeCurrentFolder method to change the FTP server's current working folder, however some FTP servers might not support absolute paths and different server types may have different ways of representing absolute paths.

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.

The BeginChangeToParentFolder%M:Xceed.Ftp.AsyncFtpClient.EndChangeToParentFolder(System.IAsyncResult)% methods should be used in the case where you want the parent folder to be the new current working folder.

The current working folder can be retrieved via the BeginGetCurrentFolderEndGetCurrentFolder methods.

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