FormPrompt

Cicode Programming Reference > Cicode Function Categories > Form Functions Introduction > FormPrompt

FormPrompt

Adds a prompt field to the current form. You should call this function only after the FormNew() function and before the FormRead() function.

Syntax

FormPrompt(Col, Row, Prompt)

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.

Return Value

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

Related Functions

FormNew, FormRead

Example

FormPrompt(1,2,"Enter Recipe");