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

1.40 / 1.00.00

Nav. API level:

1


This function will delete a group of data from the navigation device.

 

 

Input:

type : DINT

The type of data to delete from the navigation device.

0

- Deletes all destinations.

1

- Deletes all messages.

2

- Deletes the active route.

3

- Deletes all quick messages.

4

- Deletes all message replies.

5

- Deletes GPI file.

6

- Deletes user ID and status.

8

- Deletes all waypoints.

10

- Deletes all custom forms.

11

- Deletes all custom avoidance areas.

12

- Deletes all sensor displays.

 

Returns: INT

0

- Success.

-1

- Navigation interface is not open.

-2

- Error communicating with navigation device.

-12

- Navigation interface is busy.

 

Declaration:

FUNCTION navDeleteData : INT;
VAR_INPUT
  type : DINT;
END_VAR;

 

Example:

INCLUDE rtcu.inc
 
PROGRAM NavigationExample;
 
BEGIN
  ...
  // Delete data from the navigation device
  navDeleteData(type := 1);
  ...
END;
END_PROGRAM;