navUserStatusDelete (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 delete (remove) a textual description corresponding to a particular user status.

The user's current status cannot be removed.

 

 

Input:

id : INT

The ID used to identify the user status in navUserStatusDefine.

 

 

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 navUserStatusDelete : INT;
VAR_INPUT
  id : INT;
END_VAR;

 

Example:

INCLUDE rtcu.inc
 
PROGRAM NavigationExample;
 
BEGIN
  ...
  // Delete a user status item
  navUserStatusDelete(id := 33);
  ...
END;
END_PROGRAM;