navAvoidEnable (Function)

This function will enable or disable the support for avoidance areas on the navigation device.

Note that disabling the support may delete all the areas on the navigation device, including areas created by the user.

Input:

enable : BOOL (default TRUE)

Determines if avoidance areas should be enabled.

Returns: INT

0	- Success.
-1	- Navigation interface is not open.
-2	- Error communicating with navigation device.
-4	- The navigation device rejected the command.
-11	- Avoidance areas are not supported.
-12	- Navigation interface is busy.

Declaration:

FUNCTION navAvoidEnable : INT;
VAR_INPUT
enable : BOOL := TRUE;
END_VAR;

Example:

INCLUDE rtcu.inc

PROGRAM NavigationExample;

BEGIN
   ...
   // Enable support for avoidance areas
   navAvoidEnable();
   ...
END;
END_PROGRAM;