navUserStatusDefine (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 the textual description corresponding to a particular user status.

If there is already a status item with the specified id, the status text is updated; otherwise the status text is added to the list.

The user status list may contain up to 16 items.

 

 

Input:

id : INT

Unique ID to identify this user status.

 

text : STRING

The textual description for this status. 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 action.

-12

- Navigation interface is busy.

 

Declaration:

FUNCTION navUserStatusDefine : INT;
VAR_INPUT
  id   : INT;
  text : STRING;
END_VAR;

 

Example:

INCLUDE rtcu.inc
 
PROGRAM NavigationExample;
 
BEGIN
  ...
  navUserStatusDefine(id := 30, text := "On the way to work");
  navUserStatusDefine(id := 31, text := "At work");
  navUserStatusDefine(id := 32, text := "On the way home");
  navUserStatusDefine(id := 33, text := "At the pizza store");
  navUserStatusDefine(id := 34, text := "At home");
  ...
END;
END_PROGRAM;