Tizen Native API
|
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. |
This provides APIs related to Place Maneuver information, used in Route Search.
Typedef Documentation
typedef void* maps_route_maneuver_h |
The Route Maneuver handle.
The handle of Route Maneuver instance.
- Remarks:
- To release the handle use maps_route_maneuver_destroy().
To clone the handle use maps_route_maneuver_clone().
- Since :
- 2.4
Enumeration Type Documentation
The enumeration of direction type.
- Since :
- 2.4
- Enumerator:
The enumeration of turn type.
- Since :
- 2.4
- Enumerator:
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
- 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
- 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
- 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
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
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
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
- 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
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
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
- See also:
- maps_route_turn_type_e