This provides APIs related to Place Rating information, used in Place Discovery and Search.

Functions
int	maps_place_rating_destroy (maps_place_rating_h rating)
	Destroys the place rating handle and releases all its resources.
int	maps_place_rating_clone (const maps_place_rating_h origin, maps_place_rating_h *cloned)
	Clones the place rating handle.
int	maps_place_rating_get_count (const maps_place_rating_h rating, int *count)
	Gets the place rating count.
int	maps_place_rating_get_average (const maps_place_rating_h rating, double *average)
	Gets the place rating average.
Typedefs
typedef void *	maps_place_rating_h
	The Place Rating handle.

Typedef Documentation

typedef void* maps_place_rating_h

The Place Rating handle.

The handle of Place Rating instance.

Since :: 2.4

Remarks:: To release the handle use maps_place_rating_destroy().
To clone the handle use maps_place_rating_clone().

See also:: maps_place_rating_destroy(); maps_place_rating_clone()

Function Documentation

int maps_place_rating_clone	(	const maps_place_rating_h	origin,
		maps_place_rating_h *	cloned
	)

Clones the place rating handle.

This function clones the place rating handle origin and all its resources.

Since :: 2.4

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

Parameters:

[in]	origin	The original place rating handle
[out]	cloned	A cloned place rating 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_place_rating_destroy()

int maps_place_rating_destroy ( maps_place_rating_h rating )

Destroys the place rating handle and releases all its resources.

This function destroys the place rating handle and releases all its resources.

Since :: 2.4

Parameters:

[in] rating The place rating 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_place_rating_clone()

int maps_place_rating_get_average	(	const maps_place_rating_h	rating,
		double *	average
	)

Gets the place rating average.

This function gets the place rating average.

Since :: 2.4

Parameters:

[in]	rating	The handle to place rating handle
[out]	average	The place average rating

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_place_rating_get_count	(	const maps_place_rating_h	rating,
		int *	count
	)

Gets the place rating count.

This function gets the place rating count.

Since :: 2.4

Parameters:

[in]	rating	The handle to place rating handle
[out]	count	The place rating count

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

Functions

Typedefs

Typedef Documentation

Function Documentation