navFormReceiveReadStop (Function)

Top  Previous  Next

Architecture:

NX32 / NX32L

Device support:

MX2 turbo/encore/warp, AX9 turbo, NX-200, NX-400, NX-900

Firmware version:

4.70 / 1.30.00

Nav. API level:

12


This function will read the id of the selected stop from a field on a received form.

Note that the received form is only valid after a "Form received" event is raised; the event will not be removed until the navFormReceiveDone function is called.

 

Input:

id : DINT (1..2147483647)

ID of the field to read.

 

Output:

stop : INT

The id of the stop.

 

 

Returns: INT

0

- Success.

-1

- Navigation interface is not open.

-3

- No received form could be found.

-7

- The field could not be found.

 

Declaration:

FUNCTION navFormReceiveReadStop : INT;
VAR_INPUT
  id       : DINT;
  stop     : ACCESS INT;
END_VAR;

 

Example:

INCLUDE rtcu.inc
 
PROGRAM NavigationExample;
VAR
  val : INT;
END_VAR;
BEGIN
  ...
  // Read field 18
  navFormReceiveReadStop(ID := 18, stop := val);
  ...
END;
END_PROGRAM;