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

Functions
int	maps_place_url_destroy (maps_place_url_h url)
	Destroys the place URL handle and releases all its resources.
int	maps_place_url_clone (const maps_place_url_h origin, maps_place_url_h *cloned)
	Clones the place URL handle.
int	maps_place_url_get_path (const maps_place_url_h url, char **path)
	Gets the place URL path.
int	maps_place_url_get_description (const maps_place_url_h url, char **desc)
	Gets the place URL description.
Typedefs
typedef void *	maps_place_url_h
	The Place URL handle.

Typedef Documentation

typedef void* maps_place_url_h

The Place URL handle.

The handle of Place URL instance.

Since :: 2.3.2

Remarks:: To release the handle use maps_place_url_destroy().
To clone the handle use maps_place_url_clone().

See also:: maps_place_url_destroy(); maps_place_url_clone()

Function Documentation

int maps_place_url_clone	(	const maps_place_url_h	origin,
		maps_place_url_h *	cloned
	)

Clones the place URL handle.

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

Since :: 2.3.2

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

Parameters:

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

int maps_place_url_destroy ( maps_place_url_h url )

Destroys the place URL handle and releases all its resources.

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

Since :: 2.3.2

Parameters:

[in] url The place URL 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_url_clone()

int maps_place_url_get_description	(	const maps_place_url_h	url,
		char **	desc
	)

Gets the place URL description.

This function gets the place URL description.

Since :: 2.3.2

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

Parameters:

[in]	url	The handle to place url handle
[out]	desc	The place url description

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_url_get_path	(	const maps_place_url_h	url,
		char **	path
	)

Gets the place URL path.

This function gets the place URL path.

Since :: 2.3.2

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

Parameters:

[in]	url	The handle to place url handle
[out]	path	The place url path

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