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

Functions
int	maps_place_image_destroy (maps_place_image_h image)
	Destroys the place image handle and releases all its resources.
int	maps_place_image_clone (const maps_place_image_h origin, maps_place_image_h *cloned)
	Clones the place image handle.
int	maps_place_image_get_id (const maps_place_image_h image, char **id)
	Gets the place image ID.
int	maps_place_image_get_url (const maps_place_image_h image, char **url)
	Gets the place image URL.
int	maps_place_image_get_width (const maps_place_image_h image, int *width)
	Gets the place image width.
int	maps_place_image_get_height (const maps_place_image_h image, int *height)
	Gets the place image height.
int	maps_place_image_get_user_link (const maps_place_image_h image, maps_place_link_object_h *user)
	Gets the place image user link.
int	maps_place_image_get_media (const maps_place_image_h image, maps_place_media_h *media)
	Gets the place image media.
Typedefs
typedef void *	maps_place_image_h
	The Place Image handle.

Typedef Documentation

typedef void* maps_place_image_h

The Place Image handle.

The handle of Place Image instance.

Since :: 2.4

Remarks:: To release the handle use maps_place_image_destroy().
To clone the handle use maps_place_image_clone().

See also:: maps_place_image_destroy(); maps_place_image_clone()

Function Documentation

int maps_place_image_clone	(	const maps_place_image_h	origin,
		maps_place_image_h *	cloned
	)

Clones the place image handle.

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

Since :: 2.4

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

Parameters:

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

int maps_place_image_destroy ( maps_place_image_h image )

Destroys the place image handle and releases all its resources.

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

Since :: 2.4

Parameters:

[in] image The place image 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_image_clone()

int maps_place_image_get_height	(	const maps_place_image_h	image,
		int *	height
	)

Gets the place image height.

This function gets the place image height.

Since :: 2.4

Parameters:

[in]	image	The handle of place image
[out]	height	The place image height

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_image_get_id	(	const maps_place_image_h	image,
		char **	id
	)

Gets the place image ID.

This function gets the place image ID.

Since :: 2.4

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

Parameters:

[in]	image	The handle of place image
[out]	id	The place image ID

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_image_get_media	(	const maps_place_image_h	image,
		maps_place_media_h *	media
	)

Gets the place image media.

This function gets the place image media.

Since :: 2.4

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

Parameters:

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

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_h

int maps_place_image_get_url	(	const maps_place_image_h	image,
		char **	url
	)

Gets the place image URL.

This function gets the place image URL.

Since :: 2.4

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

Parameters:

[in]	image	The handle of place image
[out]	url	The place image url

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_image_get_user_link	(	const maps_place_image_h	image,
		maps_place_link_object_h *	user
	)

Gets the place image user link.

This function gets the place image user link.

Since :: 2.4

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

Parameters:

[in]	image	The handle of place image
[out]	user	The place image user 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_image_get_width	(	const maps_place_image_h	image,
		int *	width
	)

Gets the place image width.

This function gets the place image width.

Since :: 2.4

Parameters:

[in]	image	The handle of place image
[out]	width	The place image width

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