SecureBridge ComponentsTScSFTPServer.OnRenameFile
type
TScSFTPServerRenameFileEvent = procedure(Sender: TObject; SFTPSessionInfo: TScSFTPSessionInfo; const OldName, NewName: string; const Flags: TScSFTPRenameFlags; var Error: TScSFTPError) of object;
property OnRenameFile: TScSFTPServerRenameFileEvent;
Description
The OnRenameFile event occurs on request from an SFTP client to rename file or directory.
You can call the DefaultRenameFile method to execute this operation or write your own implementation.
Parameters:
| • | Sender - the object whose event handler is called. |
| • | SFTPSessionInfo - contains the information about the current SFTP session. |
| • | OldName - the name of an existing file or directory. To get an absolute file path, use the GetFullPath method. |
| • | NewName - the new name for the file or directory. |
| • | Flags - the renaming parameters. |
| • | Error - a parameter to pass the information about an error that can arise when renaming a file. |
See also