Tizen Native API
|
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_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. | |
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. | |
Typedefs | |
typedef void * | maps_place_category_h |
The Place Category handle. |
This provides APIs related to place Category information, used in Place Discovery and Search.
Typedef Documentation
typedef void* maps_place_category_h |
The Place Category handle.
The handle of Place Category instance.
- Remarks:
- To release the handle use maps_place_category_destroy().
To clone the handle use maps_place_category_clone().
- Since :
- 2.4
Function Documentation
int maps_place_category_clone | ( | const maps_place_category_h | origin, |
maps_place_category_h * | cloned | ||
) |
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] origin The original place category handle [out] cloned A cloned place category 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
- See also:
- maps_place_category_destroy()
int maps_place_category_create | ( | maps_place_category_h * | category | ) |
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] category A handle of a new place category on success
- 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
int maps_place_category_destroy | ( | maps_place_category_h | category | ) |
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] category The place category handle to destroy
- Returns:
- 0 on success, otherwise a negative error value
- Return values:
-
MAPS_ERROR_NONE Successful MAPS_ERROR_INVALID_PARAMETER Invalid parameter
- 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] category The handle of place category [out] id The place category id
- Returns:
- 0 on success, otherwise a negative error value
- Return values:
-
MAPS_ERROR_NONE Successful MAPS_ERROR_INVALID_PARAMETER Invalid parameter
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] category The handle of place category [out] name The place category name
- Returns:
- 0 on success, otherwise a negative error value
- Return values:
-
MAPS_ERROR_NONE Successful MAPS_ERROR_INVALID_PARAMETER Invalid parameter
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] category The handle of place category [out] url The place category URL
- Returns:
- 0 on success, otherwise a negative error value
- Return values:
-
MAPS_ERROR_NONE Successful MAPS_ERROR_INVALID_PARAMETER Invalid parameter
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] category The handle of place category [in] id The place category id
- Returns:
- 0 on success, otherwise a negative error value
- Return values:
-
MAPS_ERROR_NONE Successful MAPS_ERROR_INVALID_PARAMETER Invalid parameter
- Precondition:
- category is created using maps_place_category_create().
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] category The handle of place category [in] name The place category name
- Returns:
- 0 on success, otherwise a negative error value
- Return values:
-
MAPS_ERROR_NONE Successful MAPS_ERROR_INVALID_PARAMETER Invalid parameter
- Precondition:
- category is created using maps_place_category_create().
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] category The handle of place category [in] url The place category URL
- Returns:
- 0 on success, otherwise a negative error value
- Return values:
-
MAPS_ERROR_NONE Successful MAPS_ERROR_INVALID_PARAMETER Invalid parameter
- Precondition:
- category is created using maps_place_category_create().