navFormReceiveReadNumber (Function)

This function will read the value of a number 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:

number : DINT

The value of the field.

Returns: INT

Declaration:

FUNCTION navFormReceiveReadNumber : INT;
VAR_INPUT
  id         : DINT;
  number     : ACCESS DINT;
END_VAR;

Example:

INCLUDE rtcu.inc
 
PROGRAM NavigationExample;
VAR
  val : DINT;
END_VAR;
BEGIN
  ...
  // Read field 14
  navFormReceiveReadNumber(ID := 14, number := val);
  ...
END;
END_PROGRAM;