TElFTPSServer.OnFileRetrieveRequest event

TElFTPSServer.OnFileRetrieveRequest

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

Declaration

[C#]
event TSBFTPSServerFileRequestEvent OnFileRetrieveRequest;
delegate void TSBFTPSServerFileRequestEvent(Object Sender, string Path, ref int ErrorCode);

[VB.NET]
Event OnFileRetrieveRequest As TSBFTPSServerFileRequestEvent
Delegate Sub TSBFTPSServerFileRequestEvent(ByVal Sender As Object, ByVal Path As String, ByRef ErrorCode As Integer)

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

[C++]
    void get_OnFileRetrieveRequest(TSBFTPSServerFileRequestEvent &pMethodOutResult, void * &pDataOutResult);
    void set_OnFileRetrieveRequest(TSBFTPSServerFileRequestEvent pMethodValue, void * pDataValue);
    typedef void (SB_CALLBACK *TSBFTPSServerFileRequestEvent)(void * _ObjectData, TObjectHandle Sender, const char * pcPath, int32_t szPath, int32_t &ErrorCode);

[PHP]
    TSBFTPSServerFileRequestEvent|callable|NULL get_OnFileRetrieveRequest()
    void set_OnFileRetrieveRequest(TSBFTPSServerFileRequestEvent|callable|NULL $Value)
    callable TSBFTPSServerFileRequestEvent(TObject $Sender, string $Path, integer &$ErrorCode)

[Java]
    TSBFTPSServerFileRequestEvent getOnFileRetrieveRequest();
    void setOnFileRetrieveRequest(TSBFTPSServerFileRequestEvent Value);
    TSBFTPSServerFileRequestEvent.Callback OnFileRetrieveRequest = new TSBFTPSServerFileRequestEvent.Callback() {
        public void TSBFTPSServerFileRequestEventCallback(TObject Sender, String Path, TSBInteger ErrorCode) {
            //...
        }
    }

Parameters

Path - path to the requested file.
ErrorCode - return the filesystem error using this parameter.
pcPath - path to the requested file.
szPath - the length of pcPath.

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 retrieve a file from the server. Use parameter ErrorCode to specify whether the request has succeeded.

Discuss this help topic in SecureBlackbox Forum