TElSimpleFTPSServerSessionThread.OnAuthAttempt event

TElSimpleFTPSServerSessionThread.OnAuthAttempt

TElSimpleFTPSServerSessionThread See also

This event is fired when a client requests authentication.

Declaration

[C#]
event TSBSimpleFTPSServerAuthAttemptEvent OnAuthAttempt;
delegate void TSBSimpleFTPSServerAuthAttemptEvent(Object Sender, string Username, string Password, ref bool Allow);

[VB.NET]
Event OnAuthAttempt As TSBSimpleFTPSServerAuthAttemptEvent
Delegate Sub TSBSimpleFTPSServerAuthAttemptEvent(ByVal Sender As Object, ByVal Username As String, ByVal Password As String, ByRef Allow As Boolean)

[Pascal]
property OnAuthAttempt : TSBSimpleFTPSServerAuthAttemptEvent;
TSBSimpleFTPSServerAuthAttemptEvent = procedure (Sender: TObject; const Username, Password : string; var Allow : boolean) of object;

[C++]
    void get_OnAuthAttempt(TSBSimpleFTPSServerAuthAttemptEvent &pMethodOutResult, void * &pDataOutResult);
    void set_OnAuthAttempt(TSBSimpleFTPSServerAuthAttemptEvent pMethodValue, void * pDataValue);
    typedef void (SB_CALLBACK *TSBSimpleFTPSServerAuthAttemptEvent)(void * _ObjectData, TObjectHandle Sender, const char * pcUsername, int32_t szUsername, const char * pcPassword, int32_t szPassword, int8_t &Allow);

[PHP]
    TSBSimpleFTPSServerAuthAttemptEvent|callable|NULL get_OnAuthAttempt()
    void set_OnAuthAttempt(TSBSimpleFTPSServerAuthAttemptEvent|callable|NULL $Value)
    callable TSBSimpleFTPSServerAuthAttemptEvent(TObject $Sender, string $Username, string $Password, bool &$Allow)

[Java]
    TSBSimpleFTPSServerAuthAttemptEvent getOnAuthAttempt();
    void setOnAuthAttempt(TSBSimpleFTPSServerAuthAttemptEvent Value);
    TSBSimpleFTPSServerAuthAttemptEvent.Callback OnAuthAttempt = new TSBSimpleFTPSServerAuthAttemptEvent.Callback() {
        public void TSBSimpleFTPSServerAuthAttemptEventCallback(TObject Sender, String Username, String Password, TSBBoolean Allow) {
            //...
        }
    }

Parameters

Username - username (login) sent by the client
Password - password sent by the client
Allow - set this parameter to True to allow authentication
pcUsername - username (login) sent by the client
szUsername - the length of pcUsername.
pcPassword - password sent by the client
szPassword - the length of pcPassword.

Description

This event is fired by TElSimpleFTPSServer when an authentication request is received. Use parameter Allow to allow/disallow authentication.