TElSFTPServer.OnRenameFile event

TElSFTPServer.OnRenameFile

This event is fired when your software has to rename some file.

Declaration

[C#]
event TElSFTPServerRenameFileEvent OnRenameFile;
delegate void TElSFTPServerRenameFileEvent(Object Sender, string OldPath, string NewPath, TSBSftpRenameFlags Flags, ref int ErrorCode, ref string Comment);

[VB.NET]
Event OnRenameFile As TElSFTPServerRenameFileEvent
Delegate Sub TElSFTPServerRenameFileEvent(ByVal Sender As Object, ByVal OldPath As String, ByVal NewPath As String, ByVal Flags As TSBSftpRenameFlags, ByRef ErrorCode As Integer, ByRef Comment As String)

[Pascal]
    property OnRenameFile: TSBSFTPServerRenameFileEvent;
    TSBSFTPServerRenameFileEvent = procedure(Sender : TObject; const OldPath, NewPath : string; Flags : TSBSftpRenameFlags; var ErrorCode : integer; var Comment : string) of object;

    TSBSftpRenameFlags = set of TSBSftpRenameFlag;

[C++]
    void get_OnRenameFile(TElSFTPServerRenameFileEvent &pMethodOutResult, void * &pDataOutResult);
    void set_OnRenameFile(TElSFTPServerRenameFileEvent pMethodValue, void * pDataValue);
    typedef void (SB_CALLBACK *TElSFTPServerRenameFileEvent)(void * _ObjectData, TObjectHandle Sender, const char * pcOldPath, int32_t szOldPath, const char * pcNewPath, int32_t szNewPath, TSBSftpRenameFlagsRaw Flags, int32_t &ErrorCode, char * pcComment, int32_t &szComment);

[PHP]
    TElSFTPServerRenameFileEvent|callable|NULL get_OnRenameFile()
    void set_OnRenameFile(TElSFTPServerRenameFileEvent|callable|NULL $Value)
    callable TElSFTPServerRenameFileEvent(TObject $Sender, string $OldPath, string $NewPath, integer $Flags, integer &$ErrorCode, string &$Comment)

[Java]
    TElSFTPServerRenameFileEvent getOnRenameFile();
    void setOnRenameFile(TElSFTPServerRenameFileEvent Value);
    TElSFTPServerRenameFileEvent.Callback OnRenameFile = new TElSFTPServerRenameFileEvent.Callback() {
        public void TElSFTPServerRenameFileEventCallback(TObject Sender, String OldPath, String NewPath, int Flags, TSBInteger ErrorCode, TSBString Comment) {
            //...
        }
    }

Parameters

OldPath - path to existing file
NewPath - specifies the new name/location of the file
Flags - specifies renaming options
ErrorCode - the error code, see values below
Comment - server comment
pcOldPath - path to existing file
szOldPath - the length of pcOldPath.
pcNewPath - specifies the new name/location of the file
szNewPath - the length of pcNewPath.
pcComment - server comment
szComment - the length of pcComment.

Flags values:

[.NET]	[Pascal]	[C++]	Description
rfOverwrite = 1	rfOverwrite	f_rfOverwrite = 1	Overwrite file with the same name, if it exists
rfAtomic = 2	rfAtomic	f_rfAtomic = 2	If destination file already exists, it is replaced in an atomic fashion.I.e., there is no observable instant in time where the name does not refer to either the old or the new file.rfAtomic implies rfOverwrite
rfNative = 4	rfNative	f_rfNative = 4	The server is free to do the rename operation in whatever fashion it deems appropriate

TSBSftpRenameFlagsRaw values

[.NET][C++]	[Pascal]	[PHP]	Description
f_rfOverwrite = 1	rfOverwrite	rfOverwrite = 1	...
f_rfAtomic = 2	rfAtomic	rfAtomic = 2	...
f_rfNative = 4	rfNative	rfNative = 4	...

Error codes values:

Definition	Value	Description
SSH_ERROR_WRONG_MODE	-1 (0xFFFFFFFF)	Attempt to call synchronous method in asynchronous mode and vice versa
SSH_ERROR_OK	0 (0x0000)	Indicates successful completion of the operation
SSH_ERROR_EOF	1 (0x0001)	indicates end-of-file condition; Read: no more data is available in the file; ReadDirectory: no more files are contained in the directory
SSH_ERROR_NO_SUCH_FILE	2 (0x0002)	A reference is made to a file which does not exist
SSH_ERROR_PERMISSION_DENIED	3 (0x0003)	the authenticated user does not have sufficient permissions to perform the operation
SSH_ERROR_FAILURE	4 (0x0004)	An error occurred for which there is no more specific error code defined
SSH_ERROR_BAD_MESSAGE	5 (0x0005)	A badly formatted packet or protocol incompatibility is detected
SSH_ERROR_NO_CONNECTION	6 (0x0006)	A pseudo-error which indicates that the client has no connection to the server
SSH_ERROR_CONNECTION_LOST	7 (0x0007)	A pseudo-error which indicates that the connection to the server has been lost
SSH_ERROR_OP_UNSUPPORTED	8 (0x0008)	An attempt was made to perform an operation which is not supported for the server
SSH_ERROR_INVALID_HANDLE	9 (0x0009)	The handle value was invalid
SSH_ERROR_NO_SUCH_PATH	10 (0x000A)	The file path does not exist or is invalid
SSH_ERROR_FILE_ALREADY_EXISTS	11 (0x000B)	The file already exists
SSH_ERROR_WRITE_PROTECT	12 (0x000C)	The file is on read only media, or the media is write protected
SSH_ERROR_NO_MEDIA	13 (0x000D)	The requested operation can not be completed because there is no media available in the drive
SSH_ERROR_NO_SPACE_ON_FILESYSTEM	14 (0x000E)	The requested operation cannot be completed because there is no free space on the filesystem
SSH_ERROR_QUOTA_EXCEEDED	15 (0x000F)	The operation cannot be completed because it would exceed the user's storage quota
SSH_ERROR_UNKNOWN_PRINCIPAL	16 (0x0010)	A principal referenced by the request (either the ‘owner’,‘group’, or ‘who’ field of an ACL), was unknown
SSH_ERROR_LOCK_CONFLICT	17 (0x0011)	The file could not be opened because it is locked by another process
SSH_ERROR_DIR_NOT_EMPTY	18 (0x0012)	The directory is not empty
SSH_ERROR_NOT_A_DIRECTORY	19 (0x0013)	The specified file is not a directory
SSH_ERROR_INVALID_FILENAME	20 (0x0014)	The filename is not valid
SSH_ERROR_LINK_LOOP	21 (0x0015)	Too many symbolic links encountered
SSH_ERROR_CANNOT_DELETE	22 (0x0016)	The file cannot be deleted. One possible reason is that the advisory READONLY attribute-bit is set
SSH_ERROR_INVALID_PARAMETER	23 (0x0017)	On of the parameters was out of range, or the parameters specified cannot be used together
SSH_ERROR_FILE_IS_A_DIRECTORY	24 (0x0018)	The specified file was a directory in a context where a directory cannot be used
SSH_ERROR_BYTE_RANGE_LOCK_CONFLICT	25 (0x0019)	A read or write operation failed because another process's mandatory byte-range lock overlaps with the request
SSH_ERROR_BYTE_RANGE_LOCK_REFUSED	26 (0x001A)	A request for a byte range lock was refused
SSH_ERROR_DELETE_PENDING	27 (0x001B)	An operation was attempted on a file for which a delete operation is pending
SSH_ERROR_FILE_CORRUPT	28 (0x001C)	The file is corrupt; an filesystem integrity check should be run
SSH_ERROR_OWNER_INVALID	29 (0x001D)	The principal specified can not be assigned as an owner of a file
SSH_ERROR_GROUP_INVALID	30 (0x001E)	The principal specified can not be assigned as the primary group of a file
SSH_ERROR_UNSUPPORTED_VERSION	100 (0x0064)	Sets of supported by client and server versions has no intersection
SSH_ERROR_INVALID_PACKET	101 (0x0065)	Invalid packet was received
SSH_ERROR_TUNNEL_ERROR	102 (0x0066)	Error is on the SSH-protocol level. The connection is closed because of SSH error
SSH_ERROR_CONNECTION_CLOSED	103 (0x0067)	Connection is closed
SSH_ERROR_UNSUPPORTED_ACTION	104 (0x0068)	…
SSH_ERROR_NOT_A_TEXT_HANDLE	105 (0x0069)	…
SSH_ERROR_CANCELLED_BY_USER	106 (0x006A)	…

Description

This event is fired when the file has to be renamed.
The application can return the error code in ErrorCode parameter and textual comment in Comment parameter.

Discuss this help topic in SecureBlackbox Forum