Vcl.DBLogDlg.LoginDialogEx

From RAD Studio API Documentation
Jump to: navigation, search

Delphi

function LoginDialogEx(const ADatabaseName: string; var AUserName, APassword: string; NameReadOnly: Boolean): Boolean;

C++

extern DELPHI_PACKAGE bool __fastcall LoginDialogEx(const System::UnicodeString ADatabaseName, System::UnicodeString &AUserName, System::UnicodeString &APassword, bool NameReadOnly);

Properties

Type Visibility Source Unit Parent
function public
Vcl.DBLogDlg.pas
Vcl.DBLogDlg.hpp
Vcl.DBLogDlg Vcl.DBLogDlg

Description

Brings up the database Login dialog to allow the user to connect to a database server.

Call LoginDialogEx to bring up the standard Login dialog box to prompt the user for a valid user name and password. The ADatabaseName parameter specifies the database for which access is being requested. The NameReadOnly parameter specifies whether the user can change the user name from within the dialog.

The dialog returns the user name and password as the AUserName and APassword parameters.

LoginDialogEx returns false if the user cancels out of the dialog. If LoginDialogEx returns true, the application can attempt to connect to the database server using the supplied user name and password.

Note: Add QDBLogDlg.pas unit (instead of DBLogDlg) to your C++ project if you want the default Database Login dialog to display at runtime. QDBLogDlg does not need to be included if your C++ application includes a DBGrid component.

See Also