LoginForm

Displays a form in which a user can log in to the Citect SCADA system by entering their name and password and local language. If the login is correct, the user is logged into the Citect SCADA 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 [, sLanguage]]])

sUserName:

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

sPassword:

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

sLanguage:

The specified language must be one of the languages defined in System/Languages (LANG.DBF). If the specified language is undefined, the default language is used by the login user, and a message "Undefined language" is shown in the prompt line.

An empty string (i.e. "") can be specified to indicate that the default language is used by the login user. The default language defined by [Language]LocalLanguage INI parameter.

The default value of this parameter is "".

Note: If the language is changed a page reload will occur.

Return Value

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

Related Functions

Login, UserLogin

Example

See Also

Security Functions

Published June 2018