Datasnap.DSAuth.TDSAuthenticationEvent

From RAD Studio API Documentation
Jump to: navigation, search

Delphi

TDSAuthenticationEvent = procedure(Sender: TObject;
const Protocol: string;
const Context: string;
const User: string;
const Password: string;
var valid: boolean;
UserRoles: TStrings) of object;

C++

typedef void __fastcall (__closure *TDSAuthenticationEvent)(System::TObject* Sender, const System::UnicodeString Protocol, const System::UnicodeString Context, const System::UnicodeString User, const System::UnicodeString Password, bool &valid, System::Classes::TStrings* UserRoles);

Properties

Type Visibility Source Unit Parent
type
typedef
public
Datasnap.DSAuth.pas
Datasnap.DSAuth.hpp
Datasnap.DSAuth Datasnap.DSAuth

Description

Event for user authentication.

TDSAuthenticationEvent is the event used by the authentication manager to perform user authentication.

The input parameters provide information on the connection being established, such as the connecting user's name and password, and provide a parameter, valid, to allow the implementation to decide whether the given user should be allowed to connect or not. UserRoles is an empty list of strings that can be populated with roles to associate with the user if you are going to allow them to pass authentication.

See Also