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

Functions
int	maps_place_attribute_destroy (maps_place_attribute_h attribute)
	Destroys the place attribute handle and releases all its resources.
int	maps_place_attribute_clone (const maps_place_attribute_h origin, maps_place_attribute_h *cloned)
	Clones the place attribute handle.
int	maps_place_attribute_get_id (const maps_place_attribute_h attribute, char **id)
	Gets the place attribute ID.
int	maps_place_attribute_get_label (const maps_place_attribute_h attribute, char **label)
	Gets the place attribute label.
int	maps_place_attribute_get_text (const maps_place_attribute_h attribute, char **text)
	Gets the place attribute text.
Typedefs
typedef void *	maps_place_attribute_h
	The Place Attribute handle.

Typedef Documentation

typedef void* maps_place_attribute_h

The Place Attribute handle.

The handle of Place Attribute instance.

Since :: 2.3.2

Remarks:: To release the handle use maps_place_attribute_destroy().
To clone the handle use maps_place_attribute_clone().

See also:: maps_place_attribute_destroy(); maps_place_attribute_clone()

Function Documentation

int maps_place_attribute_clone	(	const maps_place_attribute_h	origin,
		maps_place_attribute_h *	cloned
	)

Clones the place attribute handle.

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

Since :: 2.3.2

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

Parameters:

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

int maps_place_attribute_destroy ( maps_place_attribute_h attribute )

Destroys the place attribute handle and releases all its resources.

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

Since :: 2.3.2

Parameters:

[in] attribute The place attribute 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_attribute_clone()

int maps_place_attribute_get_id	(	const maps_place_attribute_h	attribute,
		char **	id
	)

Gets the place attribute ID.

This function gets the place attribute ID.

Since :: 2.3.2

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

Parameters:

[in]	attribute	The handle to place attribute
[out]	id	The place attribute 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_attribute_get_label	(	const maps_place_attribute_h	attribute,
		char **	label
	)

Gets the place attribute label.

This function gets the place attribute label.

Since :: 2.3.2

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

Parameters:

[in]	attribute	The handle to place attribute
[out]	label	The place attribute label

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_attribute_get_text	(	const maps_place_attribute_h	attribute,
		char **	text
	)

Gets the place attribute text.

This function gets the place attribute text.

Since :: 2.3.2

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

Parameters:

[in]	attribute	The handle to place attribute
[out]	text	The place attribute text

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