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


Xceed.Ftp Assembly > Xceed.Ftp Namespace > AsyncFtpClient Class : BeginRenameFile(String,String,AsyncCallback,Object) Method
The filename of the file to rename. Some FTP servers may be case-sensitive!
The new filename. 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 renaming a file on the FTP server. Don't forget to call EndRenameFile!
Syntax
'Declaration
 
Public Function BeginRenameFile( _
   ByVal currentFilename As String, _
   ByVal newFilename As String, _
   ByVal callback As AsyncCallback, _
   ByVal state As Object _
) As IAsyncResult
'Usage
 
Dim instance As AsyncFtpClient
Dim currentFilename As String
Dim newFilename As String
Dim callback As AsyncCallback
Dim state As Object
Dim value As IAsyncResult
 
value = instance.BeginRenameFile(currentFilename, newFilename, callback, state)
public IAsyncResult BeginRenameFile( 
   string currentFilename,
   string newFilename,
   AsyncCallback callback,
   object state
)

Parameters

currentFilename
The filename of the file to rename. Some FTP servers may be case-sensitive!
newFilename
The new filename. 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 renamed in the current working folder. If you want to rename the file in 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.

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