RenameFile Event
An override for a file rename operation.
Syntax
public event OnRenameFileHandler OnRenameFile; public delegate void OnRenameFileHandler(object sender, FtpserverRenameFileEventArgs e); public class FtpserverRenameFileEventArgs : EventArgs { public long ConnectionID { get; } public string OldPath { get; } public string NewPath { get; } public int OperationStatus { get; set; } }
Public Event OnRenameFile As OnRenameFileHandler Public Delegate Sub OnRenameFileHandler(sender As Object, e As FtpserverRenameFileEventArgs) Public Class FtpserverRenameFileEventArgs Inherits EventArgs Public ReadOnly Property ConnectionID As Long Public ReadOnly Property OldPath As String Public ReadOnly Property NewPath As String Public Property OperationStatus As Integer End Class
Remarks
The component fires this event to let the application perform an overridden file rename operation.
This event only fires if Action = fraCustom was passed back from BeforeRenameFile event, and expects your code to perform the requested operation inside the handler. No default operation will be performed by the server component.
Use the OperationStatus parameter to return the operation result back to the server.
This event will be followed by AfterRenameFile call which will let you make final adjustments to the returned code.
Set OperationStatus to one of the following values:
ostOk | 1 | |
ostNoSuchFile | 2 | |
ostAccessDenied | 3 | |
ostWriteProtect | 4 | |
ostUnsupported | 5 | |
ostInvalidParameter | 6 | |
ostEOF | 7 |