This provides APIs related to Place Maneuver information, used in Route Search.

Functions
int	maps_route_maneuver_destroy (maps_route_maneuver_h maneuver)
	Destroys the route Maneuver handle and releases all its resources.
int	maps_route_maneuver_clone (const maps_route_maneuver_h origin, maps_route_maneuver_h *cloned)
	Clones the route Maneuver handle.
int	maps_route_maneuver_get_direction_id (const maps_route_maneuver_h maneuver, maps_route_direction_e *direction_id)
	Gets the route Maneuver direction ID.
int	maps_route_maneuver_get_turn_type (const maps_route_maneuver_h maneuver, maps_route_turn_type_e *turn_type)
	Gets the route Maneuver turn type.
int	maps_route_maneuver_get_position (const maps_route_maneuver_h maneuver, maps_coordinates_h *position)
	Gets the route Maneuver position.
int	maps_route_maneuver_get_road_name (const maps_route_maneuver_h maneuver, char **road_name)
	Gets the road name of the route Maneuver.
int	maps_route_maneuver_get_instruction_text (const maps_route_maneuver_h maneuver, char **instruction_text)
	Gets the instruction text (narrative) of the route Maneuver.
int	maps_route_maneuver_get_locale (const maps_route_maneuver_h maneuver, char **locale)
	Gets the route Maneuver locale.
int	maps_route_maneuver_get_time_to_next_instruction (const maps_route_maneuver_h maneuver, int *time_to_next_instruction)
	Gets the time to next instruction of the route Maneuver.
int	maps_route_maneuver_get_distance_to_next_instruction (const maps_route_maneuver_h maneuver, double *distance_to_next_instruction)
	Gets the distance to next instruction of the route Maneuver.
Typedefs
typedef void *	maps_route_maneuver_h
	The Route Maneuver handle.

Typedef Documentation

typedef void* maps_route_maneuver_h

The Route Maneuver handle.

The handle of Route Maneuver instance.

Since :: 2.4

Remarks:: To release the handle use maps_route_maneuver_destroy().
To clone the handle use maps_route_maneuver_clone().

See also:: maps_route_maneuver_destroy(); maps_route_maneuver_clone()

Enumeration Type Documentation

enum maps_route_direction_e

Enumeration for direction type.

Since :: 2.4

Enumerator:

MAPS_ROUTE_DIRECTION_NONE	Indicates unknown direction
MAPS_ROUTE_DIRECTION_NORTH	Indicates north direction
MAPS_ROUTE_DIRECTION_NORTHWEST	Indicates north-west direction
MAPS_ROUTE_DIRECTION_NORTHEAST	Indicates north-east direction
MAPS_ROUTE_DIRECTION_SOUTH	Indicates south direction
MAPS_ROUTE_DIRECTION_SOUTHEAST	Indicates south-east direction
MAPS_ROUTE_DIRECTION_SOUTHWEST	Indicates south-west direction
MAPS_ROUTE_DIRECTION_WEST	Indicates west direction
MAPS_ROUTE_DIRECTION_EAST	Indicates east direction

enum maps_route_turn_type_e

Enumeration for the turn type.

Since :: 2.4

Enumerator:

MAPS_ROUTE_TURN_TYPE_NONE	Indicates unknown instruction.
MAPS_ROUTE_TURN_TYPE_STRAIGHT	Indicates instruction to move straight
MAPS_ROUTE_TURN_TYPE_BEAR_RIGHT	Indicates instruction to bear right.
MAPS_ROUTE_TURN_TYPE_LIGHT_RIGHT	Indicates instruction slightly to the right.
MAPS_ROUTE_TURN_TYPE_RIGHT	Indicates instruction to turn right.
MAPS_ROUTE_TURN_TYPE_HARD_RIGHT	Indicates instruction to turn hard to the right.
MAPS_ROUTE_TURN_TYPE_UTURN_RIGHT	Indicates instruction to u-turn to the right.
MAPS_ROUTE_TURN_TYPE_UTURN_LEFT	Indicates instruction to u-turn to the left.
MAPS_ROUTE_TURN_TYPE_HARD_LEFT	Indicates instruction to turn hard to the left.
MAPS_ROUTE_TURN_TYPE_LEFT	Indicates instruction to turn left.
MAPS_ROUTE_TURN_TYPE_LIGHT_LEFT	Indicates instruction to turn lightly to the left.
MAPS_ROUTE_TURN_TYPE_BEAR_LEFT	Indicates instruction to bear left.
MAPS_ROUTE_TURN_TYPE_RIGHT_FORK	Indicates right fork instruction.
MAPS_ROUTE_TURN_TYPE_LEFT_FORK	Indicates left fork instruction.
MAPS_ROUTE_TURN_TYPE_STRAIGHT_FORK	Indicates straight fork instruction.

Function Documentation

int maps_route_maneuver_clone	(	const maps_route_maneuver_h	origin,
		maps_route_maneuver_h *	cloned
	)

Clones the route Maneuver handle.

This function clones the route Maneuver handle origin and all its resources.

Since :: 2.4

Remarks:: cloned must be released using maps_route_maneuver_destroy().

Parameters:

[in]	origin	The original Maneuver handle
[out]	cloned	A cloned Maneuver handle

Returns:: 0 on success, otherwise a negative error value

Return values:

MAPS_ERROR_NONE	Successful
MAPS_ERROR_OUT_OF_MEMORY	Out of memory
MAPS_ERROR_INVALID_PARAMETER	Invalid parameter
MAPS_ERROR_NOT_SUPPORTED	Not supported

See also:: maps_route_maneuver_destroy()

int maps_route_maneuver_destroy ( maps_route_maneuver_h maneuver )

Destroys the route Maneuver handle and releases all its resources.

This function destroys the route Maneuver handle and releases all its resources.

Since :: 2.4

Parameters:

[in] maneuver The Maneuver handle to destroy

Returns:: 0 on success, otherwise a negative error value

Return values:

MAPS_ERROR_NONE	Successful
MAPS_ERROR_INVALID_PARAMETER	Invalid parameter
MAPS_ERROR_NOT_SUPPORTED	Not supported

See also:: maps_route_maneuver_clone()

int maps_route_maneuver_get_direction_id	(	const maps_route_maneuver_h	maneuver,
		maps_route_direction_e *	direction_id
	)

Gets the route Maneuver direction ID.

This function gets the route Maneuver direction ID.

Since :: 2.4

Parameters:

[in]	maneuver	The Maneuver handle
[out]	direction_id	The direction ID

Returns:: 0 on success, otherwise a negative error value

Return values:

MAPS_ERROR_NONE	Successful
MAPS_ERROR_INVALID_PARAMETER	Invalid parameter
MAPS_ERROR_NOT_SUPPORTED	Not supported

See also:: maps_route_direction_e

int maps_route_maneuver_get_distance_to_next_instruction	(	const maps_route_maneuver_h	maneuver,
		double *	distance_to_next_instruction
	)

Gets the distance to next instruction of the route Maneuver.

This function gets the distance to next instruction of the route Maneuver.

Since :: 2.4

Parameters:

[in]	maneuver	The Maneuver handle
[out]	distance_to_next_instruction	The distance from the current Maneuver to the next Maneuver

Returns:: 0 on success, otherwise a negative error value

Return values:

MAPS_ERROR_NONE	Successful
MAPS_ERROR_INVALID_PARAMETER	Invalid parameter
MAPS_ERROR_NOT_SUPPORTED	Not supported

int maps_route_maneuver_get_instruction_text	(	const maps_route_maneuver_h	maneuver,
		char **	instruction_text
	)

Gets the instruction text (narrative) of the route Maneuver.

This function gets the instruction text (narrative) of the route Maneuver.

Since :: 2.4

Remarks:: instruction_text must be released using free().

Parameters:

[in]	maneuver	The Maneuver handle
[in]	instruction_text	The instruction text

Returns:: 0 on success, otherwise a negative error value

Return values:

MAPS_ERROR_NONE	Successful
MAPS_ERROR_INVALID_PARAMETER	Invalid parameter
MAPS_ERROR_NOT_SUPPORTED	Not supported

int maps_route_maneuver_get_locale	(	const maps_route_maneuver_h	maneuver,
		char **	locale
	)

Gets the route Maneuver locale.

This function gets the route Maneuver locale.

Since :: 2.4

Remarks:: locale must be released using free().

Parameters:

[in]	maneuver	The Maneuver handle
[out]	locale	The languages of instruction text and street name

Returns:: 0 on success, otherwise a negative error value

Return values:

MAPS_ERROR_NONE	Successful
MAPS_ERROR_INVALID_PARAMETER	Invalid parameter
MAPS_ERROR_NOT_SUPPORTED	Not supported

int maps_route_maneuver_get_position	(	const maps_route_maneuver_h	maneuver,
		maps_coordinates_h *	position
	)

Gets the route Maneuver position.

This function gets the route Maneuver position.

Since :: 2.4

Remarks:: position must be released using maps_coordinates_destroy().

Parameters:

[in]	maneuver	The Maneuver handle
[out]	position	The start position of the Maneuver

Returns:: 0 on success, otherwise a negative error value

Return values:

MAPS_ERROR_NONE	Successful
MAPS_ERROR_INVALID_PARAMETER	Invalid parameter
MAPS_ERROR_NOT_SUPPORTED	Not supported

See also:: maps_coordinates_h

int maps_route_maneuver_get_road_name	(	const maps_route_maneuver_h	maneuver,
		char **	road_name
	)

Gets the road name of the route Maneuver.

This function gets the road name of the route Maneuver.

Since :: 2.4

Remarks:: road_name must be released using free().

Parameters:

[in]	maneuver	The Maneuver handle
[out]	road_name	The current road name of the Maneuver handle

Returns:: 0 on success, otherwise a negative error value

Return values:

MAPS_ERROR_NONE	Successful
MAPS_ERROR_INVALID_PARAMETER	Invalid parameter
MAPS_ERROR_NOT_SUPPORTED	Not supported

int maps_route_maneuver_get_time_to_next_instruction	(	const maps_route_maneuver_h	maneuver,
		int *	time_to_next_instruction
	)

Gets the time to next instruction of the route Maneuver.

This function gets the time to next instruction of the route Maneuver.

Since :: 2.4

Parameters:

[in]	maneuver	The Maneuver handle
[out]	time_to_next_instruction	The time to next instruction on the given Maneuver handle

Returns:: 0 on success, otherwise a negative error value

Return values:

MAPS_ERROR_NONE	Successful
MAPS_ERROR_INVALID_PARAMETER	Invalid parameter
MAPS_ERROR_NOT_SUPPORTED	Not supported

int maps_route_maneuver_get_turn_type	(	const maps_route_maneuver_h	maneuver,
		maps_route_turn_type_e *	turn_type
	)

Gets the route Maneuver turn type.

This function gets the route Maneuver turn type.

Since :: 2.4

Parameters:

[in]	maneuver	The Maneuver handle
[out]	turn_type	The turn type

Returns:: 0 on success, otherwise a negative error value

Return values:

MAPS_ERROR_NONE	Successful
MAPS_ERROR_INVALID_PARAMETER	Invalid parameter
MAPS_ERROR_NOT_SUPPORTED	Not supported

See also:: maps_route_turn_type_e

Functions

Typedefs

Typedef Documentation

Enumeration Type Documentation

Function Documentation