Cicode Programming Reference > Cicode Function Categories > Form Functions > FormPassword

FormPassword

Adds both a password prompt and edit field to the current form. You should call this function only after the FormNew() function and before the FormRead() function. When FormRead() is called, the form will also display the password prompt and edit field.

The operator's input is not echoed in the field; a single asterisk (*) is displayed for each character.

Syntax

FormPassword(Col, Row, Prompt, Password, Width)

Col:

The number of the column in which the prompt will be placed. Enter a number from 0 (column 1) to the form width - 1. For example, to place the prompt in column 8, enter 7.

Row:

The number of the row in which the prompt will be placed. Enter a number from 0 (row 1) to the form height - 1. For example, to place the prompt in row 6, enter 5.

Prompt:

The prompt string.

Password:

Variable containing the password entered by the operator.

Width:

The width of the edit field.

Return Value

The field handle if it is added successfully, otherwise -1 is returned.

Related Functions

FormEdit

Example

! Add Password input.
FormPassword(1,2,"Enter Password",Password,10);

See Also

Form Functions

Published June 2018