nmpStopPopup (Function)

Top  Previous  Next

Architecture:

X32 / NX32 / NX32L

Device support:

MX2i pro, CX1 pro/flex/warp, SX1, MX2 turbo, NX-200, NX-400, NX-900, LX2

Firmware version:

2.80 / 1.00.00

Nav. API level:

2


This function causes a destination to pop up when it is set instead of just being added to the stop list in the background. This function must be called before navStopSet to prepare it. If the same ID is used multiple times, nmpStopPopup must be called before each call to navStopSet. If a destination is already shown, the new destination will be shown instead.

To close a stop shown this way, nmpStopClose can be used.

 

Input:

ID : INT

Unique ID to identify the destination when it is added.

 

popup : BOOL

TRUE:

Destination will pop up.

FALSE:

Destination will not pop up.

 

 

Returns: INT

0

- Success.

-1

- Navigation interface is not open.

-2

- Error communicating with navigation device.

-4

- The navigation device rejected the command.

-11

- This is not supported by the device (e.g. the device is not an NMP device).

-12

- Navigation interface is busy.

 

 

Declaration:

FUNCTION nmpStopPopup : INT;
VAR_INPUT
  id   : INT;
  popup : BOOL;
END_VAR;

 

Example:

INCLUDE rtcu.inc
 
PROGRAM NavigationExample;
 
BEGIN
  ...
  nmpStopPopup(id := 61, popup := TRUE);
  // Add a destination to the route
  navStopSet(id := 61, latitude := 666377598, longitude := 117525954, text := "Logic IO - main office");
  ...
END;
END_PROGRAM;