Cicode Programming Reference > Cicode Function Categories > Security Functions Introduction > LoginForm

LoginForm

Displays a form in which a user can log in to the CitectSCADA system by entering their name and password. If the login is correct, the user is logged into the CitectSCADA system with the area(s) and privilege(s) assigned to them in the Users database.

From version 7.10 this form can be pre-filled by the caller. Both Citect and Windows users are supported.

This function is a blocking function. It will block the calling Cicode task until the operation is complete.

Syntax

LoginForm(sUserName, sPassword)

sUserName:

The user's name, as defined in the Users database.

sPassword:

The user's password, as defined in the Users database.

Return Value

0 (zero) if successful, otherwise an error is returned.

Related Functions

Login, UserLogin

Example

System Keyboard

Key Sequence

Login

LoginForm

Display the Login form

Comment

Allow user login

Buttons

Text

Operator Login

LoginForm

Display the Login form

Comment

Allow user login

See Also

Security Functions