Tizen Native API  5.0
Category

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

Functions

int maps_place_category_create (maps_place_category_h *category)
 Creates a new place category handle.
int maps_place_category_clone (const maps_place_category_h origin, maps_place_category_h *cloned)
 Clones the place category handle.
int maps_place_category_destroy (maps_place_category_h category)
 Destroys the place category handle and releases all its resources.
int maps_place_category_get_id (const maps_place_category_h category, char **id)
 Gets the place category ID.
int maps_place_category_get_name (const maps_place_category_h category, char **name)
 Gets the place category name.
int maps_place_category_get_url (const maps_place_category_h category, char **url)
 Gets the place category URL.
int maps_place_category_set_id (maps_place_category_h category, const char *id)
 Sets the place category ID.
int maps_place_category_set_name (maps_place_category_h category, const char *name)
 Sets the place category name.
int maps_place_category_set_url (maps_place_category_h category, const char *url)
 Sets the place category URL.

Typedefs

typedef void * maps_place_category_h
 The Place Category handle.

Typedef Documentation

typedef void* maps_place_category_h

The Place Category handle.

The handle of Place Category instance.

Since :
2.4
Remarks:
To release the handle use maps_place_category_destroy().
To clone the handle use maps_place_category_clone().
See also:
maps_place_category_destroy()
maps_place_category_clone()

Function Documentation

Clones the place category handle.

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

Since :
2.4
Remarks:
cloned must be released using maps_place_category_destroy().
Parameters:
[in]originThe original place category handle
[out]clonedA cloned place category handle
Returns:
0 on success, otherwise a negative error value
Return values:
MAPS_ERROR_NONESuccessful
MAPS_ERROR_OUT_OF_MEMORYOut of memory
MAPS_ERROR_INVALID_PARAMETERInvalid parameter
MAPS_ERROR_NOT_SUPPORTEDNot supported
See also:
maps_place_category_destroy()

Creates a new place category handle.

This function creates a new place category handle and allocates all needed resources.

Since :
2.4
Remarks:
category must be released using maps_place_category_destroy().
category may be cloned using maps_place_category_clone().
Parameters:
[out]categoryA handle of a new place category on success
Returns:
0 on success, otherwise a negative error value
Return values:
MAPS_ERROR_NONESuccessful
MAPS_ERROR_OUT_OF_MEMORYOut of memory
MAPS_ERROR_INVALID_PARAMETERInvalid parameter
MAPS_ERROR_NOT_SUPPORTEDNot supported
See also:
maps_place_category_destroy()
maps_place_category_clone()

Destroys the place category handle and releases all its resources.

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

Since :
2.4
Parameters:
[in]categoryThe place category handle to destroy
Returns:
0 on success, otherwise a negative error value
Return values:
MAPS_ERROR_NONESuccessful
MAPS_ERROR_INVALID_PARAMETERInvalid parameter
MAPS_ERROR_NOT_SUPPORTEDNot supported
See also:
maps_place_category_clone()
int maps_place_category_get_id ( const maps_place_category_h  category,
char **  id 
)

Gets the place category ID.

This function gets the place category ID.

Since :
2.4
Remarks:
id must be released using free().
Parameters:
[in]categoryThe handle of place category
[out]idThe place category ID
Returns:
0 on success, otherwise a negative error value
Return values:
MAPS_ERROR_NONESuccessful
MAPS_ERROR_INVALID_PARAMETERInvalid parameter
MAPS_ERROR_NOT_SUPPORTEDNot supported
int maps_place_category_get_name ( const maps_place_category_h  category,
char **  name 
)

Gets the place category name.

This function gets the place category name.

Since :
2.4
Remarks:
name must be released using free().
Parameters:
[in]categoryThe handle of place category
[out]nameThe place category name
Returns:
0 on success, otherwise a negative error value
Return values:
MAPS_ERROR_NONESuccessful
MAPS_ERROR_INVALID_PARAMETERInvalid parameter
MAPS_ERROR_NOT_SUPPORTEDNot supported
int maps_place_category_get_url ( const maps_place_category_h  category,
char **  url 
)

Gets the place category URL.

This function gets the place category URL.

Since :
2.4
Remarks:
url must be released using free().
Parameters:
[in]categoryThe handle of place category
[out]urlThe place category URL
Returns:
0 on success, otherwise a negative error value
Return values:
MAPS_ERROR_NONESuccessful
MAPS_ERROR_INVALID_PARAMETERInvalid parameter
MAPS_ERROR_NOT_SUPPORTEDNot supported
int maps_place_category_set_id ( maps_place_category_h  category,
const char *  id 
)

Sets the place category ID.

This function sets the place category ID.

Since :
2.4
Parameters:
[in]categoryThe handle of place category
[in]idThe place category ID
Returns:
0 on success, otherwise a negative error value
Return values:
MAPS_ERROR_NONESuccessful
MAPS_ERROR_INVALID_PARAMETERInvalid parameter
MAPS_ERROR_NOT_SUPPORTEDNot supported
Precondition:
category is created using maps_place_category_create().
See also:
maps_place_category_create()
maps_place_category_get_id()
int maps_place_category_set_name ( maps_place_category_h  category,
const char *  name 
)

Sets the place category name.

This function sets the place category name.

Since :
2.4
Parameters:
[in]categoryThe handle of place category
[in]nameThe place category name
Returns:
0 on success, otherwise a negative error value
Return values:
MAPS_ERROR_NONESuccessful
MAPS_ERROR_INVALID_PARAMETERInvalid parameter
MAPS_ERROR_NOT_SUPPORTEDNot supported
Precondition:
category is created using maps_place_category_create().
See also:
maps_place_category_create()
maps_place_category_get_name()
int maps_place_category_set_url ( maps_place_category_h  category,
const char *  url 
)

Sets the place category URL.

This function sets the place category URL.

Since :
2.4
Parameters:
[in]categoryThe handle of place category
[in]urlThe place category URL
Returns:
0 on success, otherwise a negative error value
Return values:
MAPS_ERROR_NONESuccessful
MAPS_ERROR_INVALID_PARAMETERInvalid parameter
MAPS_ERROR_NOT_SUPPORTEDNot supported
Precondition:
category is created using maps_place_category_create().
See also:
maps_place_category_create()
maps_place_category_get_url()