This provides enumerations of Maps API preferences.

The Preferences are organized as a key-value table where available Preference keys are following strings:

* Place search preferences

* Route search preferences

Functions
int	maps_preference_create (maps_preference_h *preference)
	Creates a new maps preference handle.
int	maps_preference_destroy (maps_preference_h preference)
	Destroys the maps preference handle and releases all its resources.
int	maps_preference_clone (const maps_preference_h origin, maps_preference_h *cloned)
	Clones the maps preference handle.
int	maps_preference_get_distance_unit (const maps_preference_h preference, maps_distance_unit_e *unit)
	Gets the distance unit.
int	maps_preference_get_language (const maps_preference_h preference, char **language)
	Gets the language.
int	maps_preference_get_max_results (const maps_preference_h preference, int *max_results)
	Gets the max amount of results.
int	maps_preference_get_country_code (const maps_preference_h preference, char **country_code)
	Gets the country code.
int	maps_preference_get_route_optimization (const maps_preference_h preference, maps_route_optimization_e *optimization)
	Gets the route optimization.
int	maps_preference_get_route_transport_mode (const maps_preference_h preference, maps_route_transport_mode_e *transport_mode)
	Gets the route transport mode.
int	maps_preference_get_route_feature_weight (const maps_preference_h preference, maps_route_feature_weight_e *feature_weight)
	Gets the route feature weight.
int	maps_preference_get_route_feature (const maps_preference_h preference, maps_route_feature_e *feature)
	Gets the route feature.
int	maps_preference_get_route_alternatives_enabled (const maps_preference_h preference, bool *enable)
	Gets the enable status of alternative routes.
int	maps_preference_get (const maps_preference_h preference, const char key, char *value)
	Gets the maps preference value by key.
int	maps_preference_foreach_property (const maps_preference_h preference, maps_preference_properties_cb callback, void *user_data)
	Retrieves all maps properties.
int	maps_preference_set_distance_unit (maps_preference_h preference, const maps_distance_unit_e unit)
	Sets the maps distance unit.
int	maps_preference_set_language (maps_preference_h preference, const char *language)
	Sets the maps language.
int	maps_preference_set_max_results (maps_preference_h preference, const int max_results)
	Sets the max amount of results.
int	maps_preference_set_country_code (maps_preference_h preference, const char *country_code)
	Sets the maps country code.
int	maps_preference_set_route_optimization (maps_preference_h preference, const maps_route_optimization_e optimization)
	Sets the route optimization.
int	maps_preference_set_route_transport_mode (maps_preference_h preference, const maps_route_transport_mode_e transport_mode)
	Sets the route transport mode.
int	maps_preference_set_route_feature_weight (maps_preference_h preference, const maps_route_feature_weight_e feature_weight)
	Sets the route feature weight.
int	maps_preference_set_route_feature (maps_preference_h preference, const maps_route_feature_e feature)
	Sets the route feature.
int	maps_preference_set_route_alternatives_enabled (maps_preference_h preference, bool enable)
	Sets the enable status of alternative routes.
int	maps_preference_set_property (maps_preference_h preference, const char key, const char value)
	Sets the preference value by key.
Typedefs
typedef void *	maps_preference_h
	The Maps Preference handle.
typedef enum _maps_distance_unit_e	maps_distance_unit_e
	Enumeration of allowed distance units.
typedef enum _maps_route_optimization_e	maps_route_optimization_e
	Enumeration of allowed route optimization option.
typedef enum _maps_route_transport_mode_e	maps_route_transport_mode_e
	Enumeration of preferable route types.
typedef enum _maps_route_feature_weight_e	maps_route_feature_weight_e
	Enumeration of route feature weights.
typedef enum _maps_route_request_feature_e	maps_route_feature_e
	Enumeration of route features.
typedef bool(*	maps_preference_properties_cb )(int index, int total, char key, char value, void *user_data)
	Called when requesting the list of Maps Properties.
Defines
#define	MAPS_PLACE_FILTER_TYPE "MAPS_PLACE_FILTER_TYPE"
	The name of the preference indicating place type while searching the place.
#define	MAPS_PLACE_FILTER_SORT_BY "MAPS_PLACE_FILTER_SORT_BY"
	The name of the preference indicating sorting key while searching the place.
#define	MAPS_ROUTE_FREEFORM_ADDR_TO_AVOID "MAPS_ROUTE_FREEFORM_ADDR_TO_AVOID"
	The name of the preference indicating free-form address to avoid while computing the route.
#define	MAPS_ROUTE_STRUCTED_ADDR_TO_AVOID "MAPS_ROUTE_STRUCTED_ADDR_TO_AVOID"
	The name of the preference indicating structured address to avoid while computing the route.
#define	MAPS_ROUTE_CIRCLE_AREA_TO_AVOID "MAPS_ROUTE_CIRCLE_AREA_TO_AVOID"
	The name of the preference indicating circular geographical area to avoid while computing the route.
#define	MAPS_ROUTE_RECT_AREA_TO_AVOID "MAPS_ROUTE_RECT_AREA_TO_AVOID"
	The name of the preference indicating rectangular geographical area to avoid while computing the route.
#define	MAPS_ROUTE_GEOMETRY_BOUNDING_BOX "MAPS_ROUTE_GEOMETRY_BOUNDING_BOX"
	The name of the preference indicating that route should be computed within a specified bounding box.
#define	MAPS_ROUTE_GEOMETRY_RETRIEVAL "MAPS_ROUTE_GEOMETRY_RETRIEVAL"
	The name of the preference indicating that geometry parameters should be retrieved while route processing.
#define	MAPS_ROUTE_INSTRUCTION_GEOMETRY "MAPS_ROUTE_INSTRUCTION_GEOMETRY"
	The name of the preference indicating that route should be computed with geometry instructions.
#define	MAPS_ROUTE_INSTRUCTION_BOUNDING_BOX "MAPS_ROUTE_INSTRUCTION_BOUNDING_BOX"
	The name of the preference indicating that route should be computed with bounding box instructions.
#define	MAPS_ROUTE_INSTRUCTION_RETRIEVAL "MAPS_ROUTE_INSTRUCTION_RETRIEVAL"
	The name of the preference indicating that route should be computed correspondingly to retrieval instructions.
#define	MAPS_ROUTE_REALTIME_TRAFFIC "MAPS_ROUTE_REALTIME_TRAFFIC"
	The name of the preference indicating that route should be computed in accordance to real time traffic.

Define Documentation

#define MAPS_PLACE_FILTER_SORT_BY "MAPS_PLACE_FILTER_SORT_BY"

The name of the preference indicating sorting key while searching the place.

Since :: 2.3.2

#define MAPS_PLACE_FILTER_TYPE "MAPS_PLACE_FILTER_TYPE"

The name of the preference indicating place type while searching the place.

Since :: 2.3.2

#define MAPS_ROUTE_CIRCLE_AREA_TO_AVOID "MAPS_ROUTE_CIRCLE_AREA_TO_AVOID"

The name of the preference indicating circular geographical area to avoid while computing the route.

Since :: 2.3.2

#define MAPS_ROUTE_FREEFORM_ADDR_TO_AVOID "MAPS_ROUTE_FREEFORM_ADDR_TO_AVOID"

The name of the preference indicating free-form address to avoid while computing the route.

Since :: 2.3.2

#define MAPS_ROUTE_GEOMETRY_BOUNDING_BOX "MAPS_ROUTE_GEOMETRY_BOUNDING_BOX"

The name of the preference indicating that route should be computed within a specified bounding box.

Since :: 2.3.2

#define MAPS_ROUTE_GEOMETRY_RETRIEVAL "MAPS_ROUTE_GEOMETRY_RETRIEVAL"

The name of the preference indicating that geometry parameters should be retrieved while route processing.

Since :: 2.3.2

#define MAPS_ROUTE_INSTRUCTION_BOUNDING_BOX "MAPS_ROUTE_INSTRUCTION_BOUNDING_BOX"

The name of the preference indicating that route should be computed with bounding box instructions.

Since :: 2.3.2

#define MAPS_ROUTE_INSTRUCTION_GEOMETRY "MAPS_ROUTE_INSTRUCTION_GEOMETRY"

The name of the preference indicating that route should be computed with geometry instructions.

Since :: 2.3.2

#define MAPS_ROUTE_INSTRUCTION_RETRIEVAL "MAPS_ROUTE_INSTRUCTION_RETRIEVAL"

The name of the preference indicating that route should be computed correspondingly to retrieval instructions.

Since :: 2.3.2

#define MAPS_ROUTE_REALTIME_TRAFFIC "MAPS_ROUTE_REALTIME_TRAFFIC"

The name of the preference indicating that route should be computed in accordance to real time traffic.

Since :: 2.3.2

#define MAPS_ROUTE_RECT_AREA_TO_AVOID "MAPS_ROUTE_RECT_AREA_TO_AVOID"

The name of the preference indicating rectangular geographical area to avoid while computing the route.

Since :: 2.3.2

#define MAPS_ROUTE_STRUCTED_ADDR_TO_AVOID "MAPS_ROUTE_STRUCTED_ADDR_TO_AVOID"

The name of the preference indicating structured address to avoid while computing the route.

Since :: 2.3.2

Typedef Documentation

typedef enum _maps_distance_unit_e maps_distance_unit_e

Enumeration of allowed distance units.

This enumeration represents allowed distance units used in Maps Services.

Since :: 2.3.2

See also:: maps_preference_h

typedef void* maps_preference_h

The Maps Preference handle.

The Maps Preference handle can be obtained via call of maps_preference_create().
To release the handle use maps_preference_destroy().
To clone the handle use maps_preference_clone().

Since :: 2.3.2

See also:: maps_preference_create(); maps_preference_destroy(); maps_preference_clone()

typedef bool(* maps_preference_properties_cb)(int index, int total, char *key, char *value, void *user_data)

Called when requesting the list of Maps Properties.

This callback is invoked while iterating through the list of Maps Properties.

Since :: 2.3.2

Remarks:: key and value must be released using free() and corresponding release method for property value correspondingly.

Parameters:

[in]	index	The current index of property
[in]	total	The total amount of properties
[in]	key	The key of property
[in]	value	The value of property
[in]	user_data	The user data passed from maps_preference_foreach_property()

Returns:: true to continue with the next iteration of the loop,
false to break out of the loop

Precondition:: maps_preference_foreach_property() will invoke this callback.

See also:: maps_preference_foreach_property()

typedef enum _maps_route_request_feature_e maps_route_feature_e

Enumeration of route features.

This enumeration represents allowed route features used in Route Service.

Since :: 2.3.2

See also:: _maps_distance_unit_e; _maps_route_transport_mode_e; _maps_route_feature_weight_e

typedef enum _maps_route_feature_weight_e maps_route_feature_weight_e

Enumeration of route feature weights.

This enumeration represents allowed route feature weights used in Route Service.

Since :: 2.3.2

See also:: _maps_distance_unit_e; _maps_route_transport_mode_e; _maps_route_request_feature_e

typedef enum _maps_route_optimization_e maps_route_optimization_e

Enumeration of allowed route optimization option.

This enumeration represents allowed route optimization option used in Route Service.

Since :: 2.3.2

See also:: _maps_route_transport_mode_e; _maps_route_feature_weight_e; _maps_route_request_feature_e

typedef enum _maps_route_transport_mode_e maps_route_transport_mode_e

Enumeration of preferable route types.

This enumeration represents allowed route types used in Route Service.

Since :: 2.3.2

See also:: _maps_distance_unit_e; _maps_route_feature_weight_e; _maps_route_request_feature_e

Enumeration Type Documentation

enum _maps_distance_unit_e

Enumeration of allowed distance units.

This enumeration represents allowed distance units used in Maps Services.

Since :: 2.3.2

See also:: maps_preference_h

Enumerator:

MAPS_DISTANCE_UNIT_M	for Meter
MAPS_DISTANCE_UNIT_KM	for Kilometer
MAPS_DISTANCE_UNIT_FT	for Foot
MAPS_DISTANCE_UNIT_YD	for Yard

enum _maps_route_feature_weight_e

Enumeration of route feature weights.

This enumeration represents allowed route feature weights used in Route Service.

Since :: 2.3.2

See also:: _maps_distance_unit_e; _maps_route_transport_mode_e; _maps_route_request_feature_e

Enumerator:

MAPS_ROUTE_FEATURE_WEIGHT_NORMAL	Indicates normal weighting.
MAPS_ROUTE_FEATURE_WEIGHT_PREFER	Indicates that a feature is preferred.
MAPS_ROUTE_FEATURE_WEIGHT_AVOID	Indicates that a feature is to be avoided.
MAPS_ROUTE_FEATURE_WEIGHT_SOFTEXCLUDE	Indicates that soft-exclude applies to the feature.
MAPS_ROUTE_FEATURE_WEIGHT_STRICTEXCLUDE	Indicates that the feature is to be strictly excluded.

enum _maps_route_optimization_e

Enumeration of allowed route optimization option.

This enumeration represents allowed route optimization option used in Route Service.

Since :: 2.3.2

See also:: _maps_route_transport_mode_e; _maps_route_feature_weight_e; _maps_route_request_feature_e

Enumerator:

MAPS_ROUTE_TYPE_FASTEST	Indicates the fastest route
MAPS_ROUTE_TYPE_SHORTEST	Indicates the shortest route (car mode only)
MAPS_ROUTE_TYPE_ECONOMIC	Indicates the most economic route (car mode only)
MAPS_ROUTE_TYPE_SCENIC	Indicates the most scenic route
MAPS_ROUTE_TYPE_FASTESTNOW	Indicates the most fastest route now
MAPS_ROUTE_TYPE_DIRECTDRIVE	Indicates direct drive

enum _maps_route_request_feature_e

Enumeration of route features.

This enumeration represents allowed route features used in Route Service.

Since :: 2.3.2

See also:: _maps_distance_unit_e; _maps_route_transport_mode_e; _maps_route_feature_weight_e

Enumerator:

MAPS_ROUTE_FEATURE_NO	Indicates no route features (are selected).
MAPS_ROUTE_FEATURE_TOLL	Indicates toll roads (toll gates/booths).
MAPS_ROUTE_FEATURE_MOTORWAY	Indicates motorway.
MAPS_ROUTE_FEATURE_BOATFERRY	Indicates a boat ferry.
MAPS_ROUTE_FEATURE_RAILFERRY	Indicates rail (train) ferry.
MAPS_ROUTE_FEATURE_PUBLICTTRANSIT	Indicates public transport.
MAPS_ROUTE_FEATURE_TUNNEL	Indicates tunnel.
MAPS_ROUTE_FEATURE_DIRTROAD	Indicates dirt road.
MAPS_ROUTE_FEATURE_PARKS	Indicates park.
MAPS_ROUTE_FEATURE_HOVLANE	Indicates a high-occupancy vehicle lane.
MAPS_ROUTE_FEATURE_STAIRS	Indicates stairs.

enum _maps_route_transport_mode_e

Enumeration of preferable route types.

This enumeration represents allowed route types used in Route Service.

Since :: 2.3.2

See also:: _maps_distance_unit_e; _maps_route_feature_weight_e; _maps_route_request_feature_e

Enumerator:

MAPS_ROUTE_TRANSPORT_MODE_CAR	Indicates that the route is to be traveled by car.
MAPS_ROUTE_TRANSPORT_MODE_PEDESTRIAN	Indicates that the route is for a pedestrian.
MAPS_ROUTE_TRANSPORT_MODE_BICYCLE	Indicates that the route is for a cyclist.
MAPS_ROUTE_TRANSPORT_MODE_PUBLICTRANSIT	Indicates that the route is to be traveled using public transport.
MAPS_ROUTE_TRANSPORT_MODE_TRUCK	Indicates that the route is for a truck.

Function Documentation

int maps_preference_clone	(	const maps_preference_h	origin,
		maps_preference_h *	cloned
	)

Clones the maps preference handle.

This function clones the maps preference handle origin and all its resources.

Since :: 2.3.2

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

Parameters:

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

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

Return values:

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

See also:: maps_preference_destroy()

int maps_preference_create ( maps_preference_h * preference )

Creates a new maps preference handle.

This function creates a new maps preference handle and allocates all needed resources.

Since :: 2.3.2

Remarks:: preference must be released using maps_preference_destroy().
preference may be cloned using maps_preference_clone().

Parameters:

[out] preference A newly created preference handle

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

Return values:

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

See also:: maps_preference_destroy(); maps_preference_clone()

int maps_preference_destroy ( maps_preference_h preference )

Destroys the maps preference handle and releases all its resources.

This function destroys the maps preference handle and releases all its resources.

Since :: 2.3.2

Parameters:

[in] preference The preference 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

See also:: maps_preference_clone()

int maps_preference_foreach_property	(	const maps_preference_h	preference,
		maps_preference_properties_cb	callback,
		void *	user_data
	)

Retrieves all maps properties.

This function retrieves all maps properties.

Since :: 2.3.2

Remarks:: The properties will be delivered via maps_preference_properties_cb().

Parameters:

[in]	preference	The preference handle
[in]	callback	The callback function to invoke
[in]	user_data	The user data to be passed to the callback function

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

Return values:

MAPS_ERROR_NONE	Successful
MAPS_ERROR_INVALID_PARAMETER	Invalid parameter
MAPS_ERROR_NOT_FOUND	Result not found
MAPS_ERROR_NOT_SUPPORTED	Not supported

Postcondition:: This function invokes maps_preference_properties_cb() repeatedly to retrieve each property.

See also:: maps_preference_properties_cb()

int maps_preference_get	(	const maps_preference_h	preference,
		const char *	key,
		char **	value
	)

Gets the maps preference value by key.

This function gets the maps preference value by key.

Since :: 2.3.2

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

Parameters:

[in]	preference	The preference handle
[in]	key	The preference key
[out]	value	The preference value

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_preference_get_country_code	(	const maps_preference_h	preference,
		char **	country_code
	)

Gets the country code.

This function gets the country code.

Since :: 2.3.2

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

Parameters:

[in]	preference	The preference handle
[out]	country_code	The country code

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_preference_get_distance_unit	(	const maps_preference_h	preference,
		maps_distance_unit_e *	unit
	)

Gets the distance unit.

This function gets the maps distance unit.

Since :: 2.3.2

Parameters:

[in]	preference	The preference handle
[out]	unit	The distance unit

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_preference_get_language	(	const maps_preference_h	preference,
		char **	language
	)

Gets the language.

This function gets the maps language.

Since :: 2.3.2

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

Parameters:

[in]	preference	The preference handle
[out]	language	The language

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_preference_get_max_results	(	const maps_preference_h	preference,
		int *	max_results
	)

Gets the max amount of results.

This function gets the max amount of results.

Since :: 2.3.2

Parameters:

[in]	preference	The preference handle
[out]	max_results	The max amount of results

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_preference_get_route_alternatives_enabled	(	const maps_preference_h	preference,
		bool *	enable
	)

Gets the enable status of alternative routes.

This function retrieves the enable status of alternative route.

Since :: 2.3.2

Parameters:

[in]	preference	The preference handle
[out]	enable	The enable status

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_preference_get_route_feature	(	const maps_preference_h	preference,
		maps_route_feature_e *	feature
	)

Gets the route feature.

This function gets the route feature.

Since :: 2.3.2

Parameters:

[in]	preference	The preference handle
[out]	feature	The feature

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_preference_get_route_feature_weight	(	const maps_preference_h	preference,
		maps_route_feature_weight_e *	feature_weight
	)

Gets the route feature weight.

This function gets the route feature weight.

Since :: 2.3.2

Parameters:

[in]	preference	The preference handle
[out]	feature_weight	The feature weight

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_preference_get_route_optimization	(	const maps_preference_h	preference,
		maps_route_optimization_e *	optimization
	)

Gets the route optimization.

This function gets the route optimization.

Since :: 2.3.2

Parameters:

[in]	preference	The preference handle
[out]	optimization	The route optimization

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_preference_get_route_transport_mode	(	const maps_preference_h	preference,
		maps_route_transport_mode_e *	transport_mode
	)

Gets the route transport mode.

This function gets the route transport mode.

Since :: 2.3.2

Parameters:

[in]	preference	The preference handle
[out]	transport_mode	The transport mode

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_preference_set_country_code	(	maps_preference_h	preference,
		const char *	country_code
	)

Sets the maps country code.

This function sets the maps country code.

Since :: 2.3.2

Parameters:

[in]	preference	The preference handle
[in]	country_code	The maps country code

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

Precondition:: preference is created using maps_preference_create().

See also:: maps_preference_create(); maps_preference_get_country_code()

int maps_preference_set_distance_unit	(	maps_preference_h	preference,
		const maps_distance_unit_e	unit
	)

Sets the maps distance unit.

This function sets the maps distance unit.

Since :: 2.3.2

Parameters:

[in]	preference	The preference handle
[in]	unit	The distance unit

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

Precondition:: preference is created using maps_preference_create().

See also:: maps_preference_create(); maps_preference_get_distance_unit()

int maps_preference_set_language	(	maps_preference_h	preference,
		const char *	language
	)

Sets the maps language.

This function sets the maps language.

Since :: 2.3.2

Parameters:

[in]	preference	The preference handle
[in]	language	The maps language. A language is specified as an ISO 3166 alpha-2 two letter country-code followed by ISO 639-1 for the two-letter language code. Each language tag is composed of one or more "subtags" separated by hyphens (-). Each subtag is composed of basic Latin letters or digits only. For example, "ko-KR" for Korean, "en-US" for American English.

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

Precondition:: preference is created using maps_preference_create().

See also:: maps_preference_create(); maps_preference_get_language()

int maps_preference_set_max_results	(	maps_preference_h	preference,
		const int	max_results
	)

Sets the max amount of results.

This function sets the max amount of results.

Since :: 2.3.2

Parameters:

[in]	preference	The preference handle
[in]	max_results	The max amount of results

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

Precondition:: preference is created using maps_preference_create().

See also:: maps_preference_create(); maps_preference_get_max_results()

int maps_preference_set_property	(	maps_preference_h	preference,
		const char *	key,
		const char *	value
	)

Sets the preference value by key.

This function sets the preference value assigned with a specified key.

Since :: 2.3.2

Parameters:

[in]	preference	The preference handle
[in]	key	The key
[in]	value	The value

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

Precondition:: preference is created using maps_preference_create().

See also:: maps_preference_create(); maps_preference_get_property(); maps_preference_foreach_property()

int maps_preference_set_route_alternatives_enabled	(	maps_preference_h	preference,
		bool	enable
	)

Sets the enable status of alternative routes.

This function sets the alternative routes status.

Since :: 2.3.2

Parameters:

[in]	preference	The preference handle
[in]	enable	The value to set

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

Precondition:: preference is created using maps_preference_create().

See also:: maps_preference_create(); maps_preference_get_route_alternatives_enabled()

int maps_preference_set_route_feature	(	maps_preference_h	preference,
		const maps_route_feature_e	feature
	)

Sets the route feature.

This function sets the route feature.

Since :: 2.3.2

Parameters:

[in]	preference	The preference handle
[in]	feature	The route feature

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

Precondition:: preference is created using maps_preference_create().

See also:: maps_preference_create(); maps_preference_get_route_feature()

int maps_preference_set_route_feature_weight	(	maps_preference_h	preference,
		const maps_route_feature_weight_e	feature_weight
	)

Sets the route feature weight.

This function sets the route feature weight.

Since :: 2.3.2

Parameters:

[in]	preference	The preference handle
[in]	feature_weight	The route feature weight

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

Precondition:: preference is created using maps_preference_create().

See also:: maps_preference_create(); maps_preference_get_route_feature_weight()

int maps_preference_set_route_optimization	(	maps_preference_h	preference,
		const maps_route_optimization_e	optimization
	)

Sets the route optimization.

This function sets the route optimization.

Since :: 2.3.2

Parameters:

[in]	preference	The preference handle
[in]	optimization	The route optimization

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

Precondition:: preference is created using maps_preference_create().

See also:: maps_preference_create(); maps_preference_get_route_optimization()

int maps_preference_set_route_transport_mode	(	maps_preference_h	preference,
		const maps_route_transport_mode_e	transport_mode
	)

Sets the route transport mode.

This function sets the route transport mode.

Since :: 2.3.2

Parameters:

[in]	preference	The preference handle
[in]	transport_mode	The route transport mode

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

Precondition:: preference is created using maps_preference_create().

See also:: maps_preference_create(); maps_preference_get_route_optimization()

Functions

Typedefs

Defines

Define Documentation

Typedef Documentation

Enumeration Type Documentation

Function Documentation