Discuss this help topic in SecureBlackbox Forum

TElSimpleSFTPClient.OnFileOperationResult

TElSimpleSFTPClient     See also     


Filter: C#/Java  VB.NET  Pascal  C++  PHP  


This event reports the result of particular file operation within a multi-file operation.

Declaration

[C#/Java]
    event TElSftpFileOperationResultEvent OnFileOperationResult;
    delegate void TElSftpFileOperationResultEvent(Object Sender, TSBSftpFileOperation Operation, string RemotePath, string LocalPath, int ErrorCode, string Comment, ref bool Cancel);

[VB.NET]
    Event OnFileOperationResult As TElSftpFileOperationResultEvent
    Delegate Sub TElSftpFileOperationResultEvent(ByVal Sender As Object, ByVal Operation As TSBSftpFileOperation, ByVal RemotePath As String, ByVal LocalPath As String, ByVal ErrorCode As Integer, ByVal Comment As String, ByRef Cancel As Boolean)

[Pascal]
    property OnFileOperationResult: TElSftpFileOperationResultEvent;
    TElSftpFileOperationResultEvent = procedure(Sender : TObject; Operation : TSBSftpFileOperation; RemotePath : string; LocalPath : string; ErrorCode : integer; const Comment : string; var Cancel : boolean) of object;

[C++]
    void get_OnFileOperationResult(TElSftpFileOperationResultEvent &pMethodOutResult, void * &pDataOutResult);
    void set_OnFileOperationResult(TElSftpFileOperationResultEvent pMethodValue, void * pDataValue);
    typedef void (SB_CALLBACK *TElSftpFileOperationResultEvent)(void * _ObjectData, TObjectHandle Sender, TSBSftpFileOperationRaw Operation, const char * pcRemotePath, int32_t szRemotePath, const char * pcLocalPath, int32_t szLocalPath, int32_t ErrorCode, const char * pcComment, int32_t szComment, int8_t &Cancel);

[PHP]
    TElSftpFileOperationResultEvent|callable|NULL get_OnFileOperationResult()
    void set_OnFileOperationResult(TElSftpFileOperationResultEvent|callable|NULL $Value)
    callable TElSftpFileOperationResultEvent(TObject $Sender, integer $Operation, string $RemotePath, string $LocalPath, integer $ErrorCode, string $Comment, bool &$Cancel)

Parameters

  • Operation - the operation to be performed on the file.
  • RemotePath - the name and path to the remote file.
  • LocalPath - the name and path to the local file.
  • ErrorCode - operation error code.
  • Comment - error comment.
  • Cancel - allows to cancel the operation.
  • pcRemotePath - the name and path to the remote file.
  • szRemotePath - the length of pcRemotePath.
  • pcLocalPath - the name and path to the local file.
  • szLocalPath - the length of pcLocalPath.
  • pcComment - error comment.
  • szComment - the length of pcComment.

Values:



Description

    This event is fired by TElSimpleSFTPClient when file operation on particular file in a multi-file operation UploadFiles or DownloadFiles is finished.

See also:     OnFileOperation     DownloadFiles     UploadFiles    

Discuss this help topic in SecureBlackbox Forum