Discuss this help topic in SecureBlackbox Forum

TElSftpClient.OnError

TElSftpClient     See also     


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


This event is fired when the error occurs during protocol flow

Declaration

[C#]
    event TSBSftpErrorEvent OnError;
    delegate void TSBSftpErrorEvent(Object Sender, int ErrorCode, string Comment);

[VB.NET]
    Event OnError As TSBSftpErrorEvent
    Delegate Sub TSBSftpErrorEvent(ByVal Sender As Object, ByVal ErrorCode As Integer, ByVal Comment As String)

[Pascal]
    property OnError : TSBSftpErrorEvent;
    TSBSftpErrorEvent = procedure (Sender: TObject; ErrorCode : integer; Comment : string) of object;

[C++]
    void get_OnError(TSBSftpErrorEvent &pMethodOutResult, void * &pDataOutResult);
    void set_OnError(TSBSftpErrorEvent pMethodValue, void * pDataValue);
    typedef void (SB_CALLBACK *TSBSftpErrorEvent)(void * _ObjectData, TObjectHandle Sender, int32_t ErrorCode, const char * pcComment, int32_t szComment);

[PHP]
    TSBSftpErrorEvent|callable|NULL get_OnError()
    void set_OnError(TSBSftpErrorEvent|callable|NULL $Value)
    callable TSBSftpErrorEvent(TObject $Sender, integer $ErrorCode, string $Comment)

[Java]
    TSBSftpErrorEvent getOnError();
    void setOnError(TSBSftpErrorEvent Value);
    TSBSftpErrorEvent.Callback OnError = new TSBSftpErrorEvent.Callback() {
        public void TSBSftpErrorEventCallback(TObject Sender, int ErrorCode, String Comment) {
            //...
        }
    }

Parameters

  • ErrorCode - the error code, see values below
  • Comment - server comment
  • pcComment - server comment
  • szComment - the length of pcComment.

Values:

Description

    This event is fired by TElSftpClient when error occurs during protocol flow. Comment parameter specifies the server comment in user-friendly form.
    Note, that ErrorCode value of SSH_ERROR_EOF is fired to indicate that there are no more directory entries to read or that file transfer is complete.

See also:     OnSuccess    

Discuss this help topic in SecureBlackbox Forum