nmpButtonText (Function)

Top  Previous  Next

Architecture:

X32 / NX32 / NX32L

Device support:

MX2i pro, CX1 pro/flex/warp, SX1, MX2 turbo, NX-200, NX-400, NX-900, LX2

Firmware version:

2.64 / 1.00.00

Nav. API level:

2


This function will set the text of a configurable button on the NMP.

 

 

Input:

id : INT

The ID of the button - between 1 and the button count defined in nmpButtonsDefine.

 

text : STRING

The text of the button. 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.

-8

- Illegal ID or text length.

-11

- This is not supported by the device (the device is not an NMP device).

-12

- Navigation interface is busy.

 

Declaration:

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

 

Example:

INCLUDE rtcu.inc
 
PROGRAM test;
VAR
  rc : INT;
END_VAR;
BEGIN
  ...
  // Set the text of the button
  rc := nmpButtonText(id := 1, text := "Click Me");
  IF rc <> 0 THEN
    DebugFmt(message := "Error: nmpButtonText=\1", v1 := rc);
  END_IF;
  ...
END;
END_PROGRAM;