TElFTPSServer.OnFileRenameRequest event

TElFTPSServer.OnFileRenameRequest

This event is fired when a client requests to rename a file.

Declaration

[C#]
event TSBFTPSServerFileRenameRequestEvent OnFileRenameRequest;
delegate void TSBFTPSServerFileRenameRequestEvent(Object Sender, string OldName, string NewName, ref int ErrorCode);

[VB.NET]
Event OnFileRenameRequest As TSBFTPSServerFileRenameRequestEvent
Delegate Sub TSBFTPSServerFileRenameRequestEvent(ByVal Sender As Object, ByVal OldName As String, ByVal NewName As String, ByRef ErrorCode As Integer)

[Pascal]
property OnFileRenameRequest : TSBFTPSServerFileRequestEvent;
TSBFTPSServerFileRequestEvent = procedure (Sender: TObject; const Path : string; var ErrorCode : integer) of object;

[C++]
    void get_OnFileRenameRequest(TSBFTPSServerFileRenameRequestEvent &pMethodOutResult, void * &pDataOutResult);
    void set_OnFileRenameRequest(TSBFTPSServerFileRenameRequestEvent pMethodValue, void * pDataValue);
    typedef void (SB_CALLBACK *TSBFTPSServerFileRenameRequestEvent)(void * _ObjectData, TObjectHandle Sender, const char * pcOldName, int32_t szOldName, const char * pcNewName, int32_t szNewName, int32_t &ErrorCode);

[PHP]
    TSBFTPSServerFileRenameRequestEvent|callable|NULL get_OnFileRenameRequest()
    void set_OnFileRenameRequest(TSBFTPSServerFileRenameRequestEvent|callable|NULL $Value)
    callable TSBFTPSServerFileRenameRequestEvent(TObject $Sender, string $OldName, string $NewName, integer &$ErrorCode)

[Java]
    TSBFTPSServerFileRenameRequestEvent getOnFileRenameRequest();
    void setOnFileRenameRequest(TSBFTPSServerFileRenameRequestEvent Value);
    TSBFTPSServerFileRenameRequestEvent.Callback OnFileRenameRequest = new TSBFTPSServerFileRenameRequestEvent.Callback() {
        public void TSBFTPSServerFileRenameRequestEventCallback(TObject Sender, String OldName, String NewName, TSBInteger ErrorCode) {
            //...
        }
    }

Parameters

Path - path to the requested file.
ErrorCode - return the filesystem error using this parameter.
pcOldName -
szOldName -
pcNewName -
szNewName -
OldName -
NewName -

Possible values:

Definition	Value	Description
ERROR_FACILITY_VFS	102400 (0x19000)	Base error code for VFS errors
ERROR_VFS_ERROR_FLAG	1024 (0x0400)	VFS error flag
ERROR_VFS_CUSTOM_ERROR_FLAG	2048 (0x0800)	VFS custom error flag
SB_VFS_ERROR_FILE_NOT_FOUND	103426 (0x19402)	File not found
SB_VFS_ERROR_PATH_NOT_FOUND	103427 (0x19403)	Path not found
SB_VFS_ERROR_ACCESS_DENIED	103429 (0x19405)	Access denied
SB_VFS_ERROR_WRITE_PROTECT	103443 (0x19413)	The file is write-protected
SB_VFS_ERROR_ERROR_CRC	103447 (0x19417)	CRC error
SB_VFS_ERROR_NOT_SUPPORTED	103474 (0x19432)	Operation not supported
SB_VFS_ERROR_INVALID_PARAMETER	103511 (0x19457)	Invalid parameter encountered when accessing directory entries
SB_VFS_ERROR_NO_MEDIA	104536 (0x19858)	Storage media is not accessible
SB_VFS_UNSPECIFIED_ERROR	104448 (0x19800)	Any unspecified error

Description

This event is fired by TElFTPSServer when client requests to rename a file on the server. Use parameter ErrorCode to specify whether the request has succeeded.

Discuss this help topic in SecureBlackbox Forum