navFormAddStop (Function)

Architecture:	NX32 / NX32L
Firmware version:	4.70 / 1.30.00
Nav. API level:	12

This function will add a stop selection list to the form that is currently being constructed.

The selected stop can be read from a received form by using navFormReceiveReadStop.

Input:

id : DINT (1..2147483647)

Unique ID to identify the field.

title : STRING

The title of the field. Max. 50 characters.

desc : STRING

The description of the field to show below the title while no value has been entered. Max. 60 characters.

required : BOOL (default FALSE)

Set to true to make the field required.

Returns: INT

0	- Success.
-1	- The form could not be found. Call navFormCreate first.
-3	- There is not space for more fields on the form.
-8	- Invalid parameter.

Declaration:

FUNCTION navFormAddStop : INT;
VAR_INPUT
   id         : DINT;
   title      : STRING;
   desc       : STRING;
   required   : BOOL := FALSE;
END_VAR;

Example:

INCLUDE rtcu.inc

PROGRAM NavigationExample;
VAR
   rc : INT;
END_VAR;
BEGIN
   ...
   // Add a stop field to the form.
   rc := navFormAddStop(id:=6, title:="Stop", desc:="Select stop");
   DebugFmt(message := "Add stop=\1", v1 := rc);
   ...
END;
END_PROGRAM;