Register for corridor crossed events

Register a route corridor crossed listener. More...

Variables
static final int	MSG_RI_REGISTER_ROUTE_CORRIDOR_CROSSED_LISTENER = 704

Detailed Description

Register a route corridor crossed listener.

Starts listening for crossing a given corridor around the current route.
After sending this message, the navigation software will define a corridor with a given extent around the current route.
When the corridor is crossed either from the outside to the inside or vice versa, PTV Navigator will send an event of type EVENT_ROUTE_CORRIDOR_CROSSED. The returned bundle contains an unique id of the currently registered corridor. This id is needed to identify the correct corridor in case of crossing or if you wish to unregister.

Sending bundle:

Key	Value	Type	Info
Extent	The width of the corridor around the current route	int

Returned bundle:

Key	Value	Type	Info
CorridorId	The unique id of the current corridor	int

Returned error codes:

RI_ERROR_NONE if everything is ok.
RI_ERROR_RI_DISABLED if the Remote Interface service is disabled and/or not licensed.
RI_ERROR_IS_INITIALIZING if the Remote Interface service is not initialized yet.
RI_ERROR_NOT_ALLOWED if there is currently no route.