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

Functions
int	maps_place_media_destroy (maps_place_media_h media)
	Destroys the place media handle and releases all its resources.
int	maps_place_media_clone (const maps_place_media_h origin, maps_place_media_h *cloned)
	Clones the place media handle.
int	maps_place_media_get_attribution (const maps_place_media_h media, char **attribution)
	Gets the place media attribution.
int	maps_place_media_get_supplier (const maps_place_media_h media, maps_place_link_object_h *supplier)
	Gets the place media supplier link.
int	maps_place_media_get_via (const maps_place_media_h media, maps_place_link_object_h *via)
	Gets the place media "via" link.
Typedefs
typedef void *	maps_place_media_h
	The Place Media handle.

Typedef Documentation

typedef void* maps_place_media_h

The Place Media handle.

The handle of Place Media instance.

Since :: 2.3.2

Remarks:: To release the handle use maps_place_media_destroy().
To clone the handle use maps_place_media_clone().

See also:: maps_place_media_destroy(); maps_place_media_clone()

Function Documentation

int maps_place_media_clone	(	const maps_place_media_h	origin,
		maps_place_media_h *	cloned
	)

Clones the place media handle.

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

Since :: 2.3.2

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

Parameters:

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

int maps_place_media_destroy ( maps_place_media_h media )

Destroys the place media handle and releases all its resources.

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

Since :: 2.3.2

Parameters:

[in] media The place media 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_media_clone()

int maps_place_media_get_attribution	(	const maps_place_media_h	media,
		char **	attribution
	)

Gets the place media attribution.

This function gets the place media attribution.

Since :: 2.3.2

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

Parameters:

[in]	media	The handle of place media
[out]	attribution	The place media attribution

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_media_get_supplier	(	const maps_place_media_h	media,
		maps_place_link_object_h *	supplier
	)

Gets the place media supplier link.

This function gets the place media supplier link.

Since :: 2.3.2

Remarks:: supplier must be released using maps_place_link_object_destroy().

Parameters:

[in]	media	The handle of place media
[out]	supplier	The place media supplier link

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_link_object_h

int maps_place_media_get_via	(	const maps_place_media_h	media,
		maps_place_link_object_h *	via
	)

Gets the place media "via" link.

This function gets the place media "via" link.

Since :: 2.3.2

Remarks:: via must be released using maps_place_link_object_destroy().

Parameters:

[in]	media	The handle of place media
[out]	via	The place media via link

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_link_object_h

Functions

Typedefs

Typedef Documentation

Function Documentation