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

Functions
int	maps_place_contact_destroy (maps_place_contact_h contact)
	Destroys the place contact handle and releases all its resources.
int	maps_place_contact_clone (const maps_place_contact_h origin, maps_place_contact_h *cloned)
	Clones the place contact handle.
int	maps_place_contact_get_label (const maps_place_contact_h contact, char **label)
	Gets the place contact label.
int	maps_place_contact_get_type (const maps_place_contact_h contact, char **type)
	Gets the place contact type.
int	maps_place_contact_get_value (const maps_place_contact_h contact, char **value)
	Gets the place contact value.
Typedefs
typedef void *	maps_place_contact_h
	The Place Contact handle.

Typedef Documentation

typedef void* maps_place_contact_h

The Place Contact handle.

The handle of Place Contact instance.

Since :: 2.4

Remarks:: To release the handle use maps_place_contact_destroy().
To clone the handle use maps_place_contact_clone().

See also:: maps_place_contact_destroy(); maps_place_contact_clone()

Function Documentation

int maps_place_contact_clone	(	const maps_place_contact_h	origin,
		maps_place_contact_h *	cloned
	)

Clones the place contact handle.

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

Since :: 2.4

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

Parameters:

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

int maps_place_contact_destroy ( maps_place_contact_h contact )

Destroys the place contact handle and releases all its resources.

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

Since :: 2.4

Parameters:

[in] contact The place contact 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_contact_clone()

int maps_place_contact_get_label	(	const maps_place_contact_h	contact,
		char **	label
	)

Gets the place contact label.

This function gets the place contact label.

Since :: 2.4

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

Parameters:

[in]	contact	The handle to place contact
[out]	label	The place contact 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_contact_get_type	(	const maps_place_contact_h	contact,
		char **	type
	)

Gets the place contact type.

This function gets the place contact type.

Since :: 2.4

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

Parameters:

[in]	contact	The handle to place contact
[out]	type	The place contact 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

int maps_place_contact_get_value	(	const maps_place_contact_h	contact,
		char **	value
	)

Gets the place contact value.

This function gets the place contact value.

Since :: 2.4

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

Parameters:

[in]	contact	The handle to place contact
[out]	value	The place contact value

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