navGPITransfer (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

Firmware version:

2.20 / 1.00.00

Nav. API level:

1


This function will start to transfer a GPI file to the navigation device.

A "GPI progress" event is raised when there are changes to the progress and/or status of the GPI transfer. See also navWaitEvent for event # 9.

Note: this function is not supported on the NMP.

 

Input:

filename : STRING

The name and path of the file to transfer.

 

ID : STRING

A small text message to identify the GPI file.

Must be between 1 and 16 characters.

 

 

Returns: INT

0

- Success.

-1

- Navigation interface is not open.

-2

- Error communicating with navigation device.

-3

- File not found.

-4

- The navigation device rejected the command.

-8

- Invalid ID.

-12

- Navigation interface is busy.

 

Declaration:

FUNCTION navGPITransfer : INT;
VAR_INPUT
  filename : STRING;
  id       : STRING;
END_VAR;

 

Example:

INCLUDE rtcu.inc
 
PROGRAM NavigationExample;
 
BEGIN
  ...
  // Start transfer of GPI
  navGPITransfer(filename := "depart01.gpi", id := "Stores - 2010");
  ...
END;
END_PROGRAM;