Sign in Join
FPDoc Onlineexperiment

LoginDialogEx function

In unit DBLogDlg

Creates, configures, and displays a TLoginDialog dialog form.

Declaration

pascal
function LoginDialogEx(const ADatabaseName: string; 
 var AUserName: string; var APassword: string; 
 UserNameReadOnly: Boolean=False): Boolean

Arguments

ADatabaseName

Database name displayed on the form.

AUserName

User name edited on the form.

APassword

Password edited on the form.

UserNameReadOnlyTrue if the User Name cannot be changed in the form.

Function result

True when the ModalResult for the form is mrOk.

Description

LoginDialogEx is a Boolean function used to create, configure, and display a TLoginDialog dialog form. The return value contains True when the ModalResult for the form display contains the value mrOk.

LoginDialogEx creates an instance of TLoginDialog, and sets the values in the controls used on the form. The arguments in ADatabaseName, AUserName, and APassword are assigned to the corresponding controls. UserNameReadOnly indicates whether the edit control for UserName can be modified; the default value is False.

LoginDialogEx calls ShowModal to display the form as a modal dialog, and captures the ModalResult. When ModalResult contains mrOk, the return value is set to True.

LoginDialogEx frees the form instance prior to exiting from the routine.

An experiment, built from development snapshots. Not the official Free Pascal or Lazarus documentation.