navGPIReceiveID (Function)

Top  Previous  Next

Architecture:

X32 / NX32 / NX32L

Device support:

MX2, AX9, CX1 pro/flex/warp, SX1, MX2 turbo/encore/warp, AX9 turbo, NX-200, NX-400, NX-900

Firmware version:

2.20 / 1.00.00

Nav. API level:

1


This function returns the received ID of the GPI.

Note that the ID is only valid after a "GPI ID" event is raised; the event will be removed when this function is called.

A "GPI ID" event is raised when requested with navGPIRequestID.

Note: this function is not supported on the NMP.

 

 

Input:

None.

 

 

Returns: STRING

The text message that identifies the GPI. It is empty if an event is not raised.

 

 

Declaration:

FUNCTION navGPIReceiveID : STRING;

 

Example:

INCLUDE rtcu.inc
 
THREAD_BLOCK navMonitor;
VAR
  event : INT := 0;
END_VAR;
 
WHILE event <> -1 DO
  event := navWaitEvent(timeout := -1);
  CASE event OF
     ...
    8: DebugMsg(message := "GPI ID: " + navGPIReceiveID());
     ...
  END_CASE;
END_WHILE;
END_THREAD_BLOCK;