navStopSetRoute (Function)

Top Previous Next

Architecture:	NX32 / NX32L
Device support:	MX2 turbo/encore/warp, AX9 turbo, NX-200, NX-400, NX-900, LX2, LX4, LX5
Firmware version:	4.70 / 1.30.00
Nav. API level:	14

This function will upload the constructed route to the navigation device.

The upload progress will be reported with GPI progress events that can be read with navGPIProgressReceive.

When the upload is completed, navGPIProgressReceive will report any errors with the form.

See navStopSetRouteFile for a list of the additional error codes.

Input:

ID : INT

Unique ID to identify the route when a stop status is received.

Note: the ID of -1 is reserved and will result in an error.

text : STRING

A text comment to identify the route. Max. 199 characters.

Returns: INT

0	- Success.
-1	- Navigation interface is not open.
-2	- Error communicating with navigation device.
-7	- Invalid stop id.
-8	- The text is invalid.
-10	- The route is too large to upload. Call navStopRouteAbort and try again. It may be necessary to split the route into smaller routes.
-11	- Routes are not supported.
-12	- Navigation interface is busy.

Declaration:

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

Example:

INCLUDE rtcu.inc

PROGRAM NavigationExample;

BEGIN
...
// Add a route
navStopSetRoute(id := 1, text := "Route 1");
...
END;
END_PROGRAM;