'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

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.

.NET: net5.0, net5.0-windows, net6.0, net6.0-macos, net6.0-windows, net7.0, net7.0-macos, net7.0-windows, net8.0, net8.0-browser, net8.0-macos, net8.0-windows, net9.0, net9.0-browser, net9.0-macos, net9.0-windows, net10.0, net10.0-browser, net10.0-macos, net10.0-windows.

.NET Standard: netstandard2.0, netstandard2.1

.NET Framework: net20, net35, net40, net403, net45, net451, net452, net46, net461, net462, net463, net47, net471, net472, net48, net481.

Reference

AsyncFtpClient Class
AsyncFtpClient Members
EndRenameFile Method
System.IAsyncResult
EndRenameFile Method
System.IAsyncResult