navAvoidAreaEnable (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:

13

This function will enable or disable an avoidance area on the navigation device.

 

Input:

id : INT

Unique ID to identify the area.

 

enable : BOOL (default TRUE)

Determines if the area 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 navAvoidAreaEnable : INT;
VAR_INPUT
  ID     : DINT;
  enable : BOOL := TRUE;
END_VAR;

 

Example:

INCLUDE rtcu.inc
 
PROGRAM NavigationExample;
 
BEGIN
  ...
  // Disable an avoidance area
  navAvoidAreaEnable(id := 1, enable := FALSE);
  ...
END;
END_PROGRAM;