Discuss this help topic in SecureBlackbox Forum


TElSftpClient     See also     

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

This event is fired when the error occurs during protocol flow


    event TSBSftpErrorEvent OnError;
    delegate void TSBSftpErrorEvent(Object Sender, int ErrorCode, string Comment);

    Event OnError As TSBSftpErrorEvent
    Delegate Sub TSBSftpErrorEvent(ByVal Sender As Object, ByVal ErrorCode As Integer, ByVal Comment As String)

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

    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);

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

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


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


SSH_ERROR_FILE_IS_A_DIRECTORY 24 (0x0018) The specified file was a directory in a context where a directory cannot be used
SSH_ERROR_BYTE_RANGE_LOCK_CONFLICT 25 (0x0019) A read or write operation failed because another process's mandatory byte-range lock overlaps with the request SSH_ERROR_BYTE_RANGE_LOCK_REFUSED 26 (0x001A) A request for a byte range lock was refused SSH_ERROR_DELETE_PENDING 27 (0x001B) An operation was attempted on a file for which a delete operation is pending SSH_ERROR_FILE_CORRUPT 28 (0x001C) The file is corrupt; an filesystem integrity check should be run SSH_ERROR_OWNER_INVALID 29 (0x001D) The principal specified can not be assigned as an owner of a file SSH_ERROR_GROUP_INVALID 30 (0x001E) The principal specified can not be assigned as the primary group of a file SSH_ERROR_UNSUPPORTED_VERSION 100 (0x0064) Sets of supported by client and server versions has no intersection SSH_ERROR_INVALID_PACKET 101 (0x0065) Invalid packet was received SSH_ERROR_TUNNEL_ERROR 102 (0x0066) Error is on the SSH-protocol level. The connection is closed because of SSH error SSH_ERROR_CONNECTION_CLOSED 103 (0x0067) Connection is closed SSH_ERROR_UNSUPPORTED_ACTION 104 (0x0068) … SSH_ERROR_NOT_A_TEXT_HANDLE 105 (0x0069) … SSH_ERROR_CANCELLED_BY_USER 106 (0x006A) … Declared in [.NET] [Pascal] [C++] Namespace: SBSftpCommon
Assembly: SecureBlackbox.SFTPCommon Unit: SBSftpCommon sbsftpcommon.h


    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