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

1.40 / 1.00.00

Nav. API level:

1

This function will define a quick message.

If a quick message with the specified ID already exists, it will be replaced with the message text in this packet; otherwise the quick message will be added.

 

Quick messages are a list of predefined text messages that can be sent from the navigation device.

When sending a quick message, the user has the option to modify the text before sending it.

Up to 120 quick messages can be stored.

 

 

Input:

id : INT

Unique ID to identify the quick message.

 

text : STRING

The text that is sent to the RTCU device when the quick message is selected (max. 49 characters).

 

 

Returns: INT

0

- Success.

-1

- Navigation interface is not open.

-2

- Error communicating with navigation device.

-4

- The navigation device rejected the command.

-12

- Navigation interface is busy.

 

Declaration:

FUNCTION navMessageQuickDefine : INT;
VAR_INPUT
  ID   : INT;
  text : STRING;
END_VAR;

 

Example:

INCLUDE rtcu.inc
 
PROGRAM NavigationExample;
 
BEGIN
  ...
  navMessageQuickDefine(id := 10, text := "99 bottles of beer on the wall...");
  navMessageQuickDefine(id := 11, text := "Do you want the usual pizza?");
  ...
END;
END_PROGRAM;