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

2


This function will delete a text message from the navigation device.

 

 

Input:

id : INT

Unique ID of the message.

 

 

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 navigation device.

-12

- Navigation interface is busy.

 

Declaration:

FUNCTION navMessageDelete : INT;
VAR_INPUT
  ID : INT;
END_VAR;

 

Example:

INCLUDE rtcu.inc
 
PROGRAM NavigationExample;
 
BEGIN
  ...
  // Send a text message to the navigation device
  navMessageSend(id := 55, text := "Remember to pick up lunch on the way", type := 1);
  ...
  // Delete the text message
  navMessageDelete(id := 56);
  ...
END;
END_PROGRAM;