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

Functions
int	maps_place_link_object_destroy (maps_place_link_object_h link)
	Destroys the place link object handle and releases all its resources.
int	maps_place_link_object_clone (const maps_place_link_object_h origin, maps_place_link_object_h *cloned)
	Clones the place link object handle.
int	maps_place_link_object_get_id (const maps_place_link_object_h link, char **id)
	Gets the place link object ID.
int	maps_place_link_object_get_name (const maps_place_link_object_h link, char **name)
	Gets the place link object name.
int	maps_place_link_object_get_string (const maps_place_link_object_h link, char **string)
	Gets the place link object string.
int	maps_place_link_object_get_type (const maps_place_link_object_h link, char **type)
	Gets the place link object type.
Typedefs
typedef void *	maps_place_link_object_h
	The Place Link Object handle.

Typedef Documentation

typedef void* maps_place_link_object_h

The Place Link Object handle.

The handle of Place Link Object instance.

Since :: 2.3.2

Remarks:: To release the handle use maps_place_link_object_destroy().
To clone the handle use maps_place_link_object_clone().

See also:: maps_place_link_object_destroy(); maps_place_link_object_clone()

Function Documentation

int maps_place_link_object_clone	(	const maps_place_link_object_h	origin,
		maps_place_link_object_h *	cloned
	)

Clones the place link object handle.

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

Since :: 2.3.2

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

Parameters:

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

int maps_place_link_object_destroy ( maps_place_link_object_h link )

Destroys the place link object handle and releases all its resources.

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

Since :: 2.3.2

Parameters:

[in] link The place link object 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_link_object_clone()

int maps_place_link_object_get_id	(	const maps_place_link_object_h	link,
		char **	id
	)

Gets the place link object ID.

This function gets the place link object ID.

Since :: 2.3.2

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

Parameters:

[in]	link	The handle of place link object
[out]	id	The place link object 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_link_object_get_name	(	const maps_place_link_object_h	link,
		char **	name
	)

Gets the place link object name.

This function gets the place link object name.

Since :: 2.3.2

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

Parameters:

[in]	link	The handle of place link object
[out]	name	The place link object name

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_link_object_get_string	(	const maps_place_link_object_h	link,
		char **	string
	)

Gets the place link object string.

This function gets the place link object string.

Since :: 2.3.2

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

Parameters:

[in]	link	The handle of place link object
[out]	string	The place link object string

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_link_object_get_type	(	const maps_place_link_object_h	link,
		char **	type
	)

Gets the place link object type.

This function gets the place link object type.

Since :: 2.3.2

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

Parameters:

[in]	link	The handle of place link object
[out]	type	The place link object type

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