TElFTPSServer.OnFileListRequest event

TElFTPSServer.OnFileListRequest

This event is fired when a client requests a file list.

Declaration

[C#]
event TSBFTPSServerDirectoryRequestEvent OnFileListRequest;
delegate void TSBFTPSServerDirectoryRequestEvent(Object Sender, ref string Directory, ref int ErrorCode);

[VB.NET]
Event OnFileListRequest As TSBFTPSServerDirectoryRequestEvent
Delegate Sub TSBFTPSServerDirectoryRequestEvent(ByVal Sender As Object, ByRef Directory As String, ByRef ErrorCode As Integer)

[Pascal]
property OnFileListRequest : TSBFTPSServerDirectoryRequestEvent;
TSBFTPSServerDirectoryRequestEvent = procedure (Sender: TObject; var Directory : string; var ErrorCode : integer) of object;

[C++]
    void get_OnFileListRequest(TSBFTPSServerDirectoryRequestEvent &pMethodOutResult, void * &pDataOutResult);
    void set_OnFileListRequest(TSBFTPSServerDirectoryRequestEvent pMethodValue, void * pDataValue);
    typedef void (SB_CALLBACK *TSBFTPSServerDirectoryRequestEvent)(void * _ObjectData, TObjectHandle Sender, char * pcDirectory, int32_t &szDirectory, int32_t &ErrorCode);

[PHP]
    TSBFTPSServerDirectoryRequestEvent|callable|NULL get_OnFileListRequest()
    void set_OnFileListRequest(TSBFTPSServerDirectoryRequestEvent|callable|NULL $Value)
    callable TSBFTPSServerDirectoryRequestEvent(TObject $Sender, string &$Directory, integer &$ErrorCode)

[Java]
    TSBFTPSServerDirectoryRequestEvent getOnFileListRequest();
    void setOnFileListRequest(TSBFTPSServerDirectoryRequestEvent Value);
    TSBFTPSServerDirectoryRequestEvent.Callback OnFileListRequest = new TSBFTPSServerDirectoryRequestEvent.Callback() {
        public void TSBFTPSServerDirectoryRequestEventCallback(TObject Sender, TSBString Directory, TSBInteger ErrorCode) {
            //...
        }
    }

Parameters

Directory - specifies the directory name.
ErrorCode - return the filesystem error using this parameter.
pcDirectory - specifies the directory name.
szDirectory - the length of pcDirectory.

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 directory listing. Use parameter ErrorCode to specify whether the request has succeeded.

Discuss this help topic in SecureBlackbox Forum