navGPIRequestID (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, LX2, LX4, LX5

Firmware version:

2.20 / 1.00.00

Nav. API level:

1

This function will request the ID of the GPI from the navigation device.

A "GPI ID" event is raised when the ID is received. See also navWaitEvent for event # 8.

Note: this function is not supported on the NMP.

 

 

Input:

None.

 

 

Returns: INT

0

- Success.

-1

- Navigation interface is not open.

-2

- Error communicating with navigation device.

-12

- Navigation interface is busy.

 

Declaration:

FUNCTION navGPIRequestID : INT;

 

Example:

INCLUDE rtcu.inc
 
PROGRAM NavigationExample;
 
BEGIN
  ...
  // Request the ID of the GPI
  navGPIRequestID();
  ...
END;
END_PROGRAM;