Discuss this help topic in SecureBlackbox Forum

TElSimpleSSHClient.OnAuthenticationAttempt

TElSimpleSSHClient     See also     


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


This event is fired when a single authentication attempt is performed.

Declaration

[C#/Java]
    event TSSHAuthenticationAttemptEvent OnAuthenticationAttempt;
    delegate void TSSHAuthenticationAttemptEvent(Object Sender, int AuthType, Object AuthParam);

[VB.NET]
    Event OnAuthenticationAttempt As TSSHAuthenticationAttemptEvent
    Delegate Sub TSSHAuthenticationAttemptEvent(ByVal Sender As Object, ByVal AuthType As Integer, ByVal AuthParam As Object)

[Pascal]
    property OnAuthenticationAttempt : TSSHAuthenticationAttemptEvent;
    TSSHAuthenticationAttemptEvent = procedure (Sender: TObject; AuthType : integer; AuthParam: TObject) of object;

[C++]
    void get_OnAuthenticationAttempt(TSSHAuthenticationAttemptEvent &pMethodOutResult, void * &pDataOutResult);
    void set_OnAuthenticationAttempt(TSSHAuthenticationAttemptEvent pMethodValue, void * pDataValue);
    typedef void (SB_CALLBACK *TSSHAuthenticationAttemptEvent)(void * _ObjectData, TObjectHandle Sender, int32_t AuthType, TObjectHandle AuthParam);

[PHP]
    TSSHAuthenticationAttemptEvent|callable|NULL get_OnAuthenticationAttempt()
    void set_OnAuthenticationAttempt(TSSHAuthenticationAttemptEvent|callable|NULL $Value)
    callable TSSHAuthenticationAttemptEvent(TObject $Sender, integer $AuthType, TObject $AuthParam)

Parameters

  • AuthType - type of authentication
  • AuthParam - parameter which is required for authentication, depending on AuthType

Authentication types


Description

    This event is fired when the single authentication attempt is performed. The corresponding parameters contain the authentication type and authentication parameter, e.g., if SSH_AUTH_TYPE_PUBLICKEY authentication is specified, AuthParam will contain the key.

See also:     AuthenticationTypes     OnAuthenticationSuccess     OnAuthenticationFailed    

Discuss this help topic in SecureBlackbox Forum