TElSimpleFTPSClient.OnFileOperation event

TElSimpleFTPSClient.OnFileOperation

This event is fired during data reading/writing of multiple files to report the next file.

Declaration

[C#]
event TElFTPFileOperationEvent OnFileOperation;
delegate void TElFTPFileOperationEvent(Object Sender, TSBFtpFileOperation Operation, string RemotePath, string LocalPath, ref bool Skip, ref bool Cancel);

[VB.NET]
Event OnFileOperation As TElFTPFileOperationEvent
Delegate Sub TElFTPFileOperationEvent(ByVal Sender As Object, ByVal Operation As TSBFtpFileOperation, ByVal RemotePath As String, ByVal LocalPath As String, ByRef Skip As Boolean, ByRef Cancel As Boolean)

[Pascal]
property OnFileOperation : TElFTPFileOperationEvent
TElFTPFileOperationEvent = procedure(Sender : TObject; Operation As TSBFtpFileOperation, const RemotePath, LocalPath : string; var Skip, Cancel : boolean) of object;

[C++]
    void get_OnFileOperation(TElFTPFileOperationEvent &pMethodOutResult, void * &pDataOutResult);
    void set_OnFileOperation(TElFTPFileOperationEvent pMethodValue, void * pDataValue);
    typedef void (SB_CALLBACK *TElFTPFileOperationEvent)(void * _ObjectData, TObjectHandle Sender, TSBFtpFileOperationRaw Operation, const char * pcRemotePath, int32_t szRemotePath, const char * pcLocalPath, int32_t szLocalPath, int8_t &Skip, int8_t &Cancel);

[PHP]
    TElFTPFileOperationEvent|callable|NULL get_OnFileOperation()
    void set_OnFileOperation(TElFTPFileOperationEvent|callable|NULL $Value)
    callable TElFTPFileOperationEvent(TObject $Sender, integer $Operation, string $RemotePath, string $LocalPath, bool &$Skip, bool &$Cancel)

[Java]
    TElFTPFileOperationEvent getOnFileOperation();
    void setOnFileOperation(TElFTPFileOperationEvent Value);
    TElFTPFileOperationEvent.Callback OnFileOperation = new TElFTPFileOperationEvent.Callback() {
        public void TElFTPFileOperationEventCallback(TObject arg0, TSBFtpFileOperation arg1, String arg2, String arg3, TElFileOperationEventParams arg4) {
            //...
        }
    }

Parameters

Operation - the operation to be performed on the file.
RemotePath - specifies the name and path to the remote file.
LocalPath - specifies the name and path to the local file.
Skip - allows to skip the current file.
Cancel - allows to cancel the operation.
pcRemotePath - specifies the name and path to the remote file.
szRemotePath - the length of pcRemotePath.
pcLocalPath - specifies the name and path to the local file.
szLocalPath - the length of pcLocalPath.

Values

[.NET] [C++]	[Pascal]	Description
ffoDownloadFile = 0	ffoDownloadFile	Download file
ffoUploadFile = 1	ffoUploadFile	Upload file
ffoDeleteFile = 2	ffoDeleteFile	Delete file

Description

This event is fired by TElSimpleFTPSClient from DownloadFiles and UploadFiles methods to notify the application that new file transfer is to be started. The application can skip the file or cancel the whole operation. Progress of each transfer is reported via OnProgress event.

Discuss this help topic in SecureBlackbox Forum