Syntax

Engine.DisplayLoginDialog( dlgTitle, initialLoginName, initialPassword, modalToAppMainWind, userObject)

Return Value

Boolean

Returns True if you click OK in the dialog box. Returns False if you click Cancel .

Purpose

Launches a login dialog box.

Remarks

A drop-down list box in the dialog box contains the login names of all current TestStand users.

The LoginLogout Front-End callback calls this method.

Parameters

dlgTitle As String

[In] Specifies the title of the dialog box. Pass an empty string to use the default title for the dialog box.

initialLoginName As String

[In] Specifies the initial login name you want displayed in the dialog box. If you pass an empty string, the first login name in the ring control is selected.

initialPassword As String

[In] Specifies the initial password you want displayed in the dialog box. It appears on screen as all asterisks (*).

modalToAppMainWind As Boolean

[In] By default, the dialog box is modal to the last active window of the calling thread, or if there is none, to the last active window from AppMainHwnd. If you set this option, the dialog box is modal with respect to the window handle of the Engine.AppMainHwnd property. Typically, you do not need to set this option.

userObject As User

[Out] Returns the User object that represents the user who logged in.

See Also

Engine.AppMainHwnd

Engine.CurrentUser

Engine.GetUser

User