navUserIDRequest (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 request the user ID from the navigation device.

A "User ID" event is raised when the user ID is received. See also navWaitEvent for event # 6.

 

 

Input:

index : SINT (1..3, Default: 1)

The index of the user requested.

 

 

Returns: INT

0

- Success.

-1

- Navigation interface is not open.

-2

- Error communicating with navigation device.

-8

- Illegal user index.

-11

- This is not supported by navigation device.

-12

- Navigation interface is busy.

 

Declaration:

FUNCTION navUserIDRequest : INT;
VAR_INPUT
  index : SINT := 1;
END_VAR;

 

Example:

INCLUDE rtcu.inc
 
PROGRAM NavigationExample;
 
BEGIN
  ...
  // Request the current user ID
  navUserIDRequest(index := 2);
  ...
END;
END_PROGRAM;