Discuss this help topic in SecureBlackbox Forum

TElSSHServer.OnAuthBanner

TElSSHServer     See also     


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


This event requests information that should be shown to the client.

Declaration

[C#/Java]
    event TSSHAuthBannerEvent OnAuthBanner;
    delegate void TSSHAuthBannerEvent(Object Sender, string Username, int AuthType, ref string Banner, ref byte[] LanguageTag);

[VB.NET]
    Event OnAuthBanner As TSSHAuthBannerEvent
    Delegate Sub TSSHAuthBannerEvent(ByVal Sender As Object, ByVal Username As String, ByVal AuthType As Integer, ByRef Banner As String, ByRef LanguageTag As Byte())

[Pascal]
    property OnAuthBanner: TSSHAuthBannerEvent;
    
    TSSHAuthBannerEvent = procedure(Sender : TObject; const Username : string; AuthType : integer; var Banner: string; var LanguageTag : string) of object;

[C++]
    void get_OnAuthBanner(TSSHAuthBannerEvent &pMethodOutResult, void * &pDataOutResult);
    void set_OnAuthBanner(TSSHAuthBannerEvent pMethodValue, void * pDataValue);
    typedef void (SB_CALLBACK *TSSHAuthBannerEvent)(void * _ObjectData, TObjectHandle Sender, const char * pcUsername, int32_t szUsername, int32_t AuthType, char * pcBanner, int32_t &szBanner, uint8_t pLanguageTag[], int32_t &szLanguageTag);

[PHP]
    TSSHAuthBannerEvent|callable|NULL get_OnAuthBanner()
    void set_OnAuthBanner(TSSHAuthBannerEvent|callable|NULL $Value)
    callable TSSHAuthBannerEvent(TObject $Sender, string $Username, integer $AuthType, string &$Banner, string &$LanguageTag)

Parameters

  • Username - the name of the client being authenticated
  • AuthType - the type of authentication
  • Banner - message text to be shown
  • LanguageTag - language code (see RFC1766)
  • pcUsername - the name of the client being authenticated
  • szUsername - the length of pcUsername.
  • pcBanner - message text to be shown
  • szBanner - the length of pcBanner.
  • pLanguageTag -
  • szLanguageTag - the length of pcLanguageTag.

Authentication type values


Description

    This event is fired when it's necessary to show some message to the client during authentication.

See also:     OnAuthAttempt     BannerSendStage    

Discuss this help topic in SecureBlackbox Forum