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

Functions
int	maps_place_editorial_destroy (maps_place_editorial_h editorial)
	Destroys the place editorial handle and releases all its resources.
int	maps_place_editorial_clone (const maps_place_editorial_h origin, maps_place_editorial_h *cloned)
	Clones the place editorial handle.
int	maps_place_editorial_get_description (const maps_place_editorial_h editorial, char **description)
	Gets the place editorial description.
int	maps_place_editorial_get_language (const maps_place_editorial_h editorial, char **language)
	Gets the place editorial language.
int	maps_place_editorial_get_media (const maps_place_editorial_h editorial, maps_place_media_h *media)
	Gets the place editorial media.
Typedefs
typedef void *	maps_place_editorial_h
	The Place Editorial handle.

Typedef Documentation

typedef void* maps_place_editorial_h

The Place Editorial handle.

The handle of Place Editorial instance.

Since :: 2.4

Remarks:: To release the handle use maps_place_editorial_destroy().
To clone the handle use maps_place_editorial_clone().

See also:: maps_place_editorial_destroy(); maps_place_editorial_clone()

Function Documentation

int maps_place_editorial_clone	(	const maps_place_editorial_h	origin,
		maps_place_editorial_h *	cloned
	)

Clones the place editorial handle.

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

Since :: 2.4

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

Parameters:

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

int maps_place_editorial_destroy ( maps_place_editorial_h editorial )

Destroys the place editorial handle and releases all its resources.

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

Since :: 2.4

Parameters:

[in] editorial The place editorial 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_editorial_clone()

int maps_place_editorial_get_description	(	const maps_place_editorial_h	editorial,
		char **	description
	)

Gets the place editorial description.

This function gets the place editorial description.

Since :: 2.4

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

Parameters:

[in]	editorial	The handle of place editorial
[out]	description	The place editorial 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_editorial_get_language	(	const maps_place_editorial_h	editorial,
		char **	language
	)

Gets the place editorial language.

This function gets the place editorial language.

Since :: 2.4

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

Parameters:

[in]	editorial	The handle of place editorial
[out]	language	The place editorial 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_place_editorial_get_media	(	const maps_place_editorial_h	editorial,
		maps_place_media_h *	media
	)

Gets the place editorial media.

This function gets the place editorial media.

Since :: 2.4

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

Parameters:

[in]	editorial	The handle of place editorial
[out]	media	The place editorial 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

Functions

Typedefs

Typedef Documentation

Function Documentation