navWaypointDeleteByCat (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:

2


This function will delete all waypoints in the categories selected.

 

 

Input:

categories : INT

A bit field that indicates which categories to delete waypoints from.

For example, if the waypoint should be in categories with IDs 0 and 5, the categories should have the lowest bit and the 6th lowest bit set to 1 for a value of 33 decimals (00000000 00100001 in binary).

 

 

Returns: INT

0

- Success.

-1

- Navigation interface is not opened.

-2

- Error communicating with navigation device.

-4

- The navigation device rejected the command.

-11

- This is not supported by navigation device.

-12

- Navigation interface is busy.

 

Declaration:

FUNCTION navWaypointDeleteByCat : INT;
VAR_INPUT
  categories : INT;
END_VAR;

 

Example:

INCLUDE rtcu.inc
 
PROGRAM NavigationExample;
 
BEGIN
  ...
  // Delete all waypoints belonging to category 0 and 5
  navWaypointDeleteByCat(categories := 16#0041);
  ...
END;
END_PROGRAM;