Change return type to bool

[platform/core/api/media-content.git] / include / media_tag.h

diff --git a/include/media_tag.h b/include/media_tag.h
index 355611a..1b7cec3 100755 (executable)
--- a/include/media_tag.h
+++ b/include/media_tag.h
@@ -16,8 +16,8 @@
 
 
 
-#ifndef __TIZEN_MEDIA_TAG_H__
-#define __TIZEN_MEDIA_TAG_H__
+#ifndef __TIZEN_CONTENT_MEDIA_TAG_H__
+#define __TIZEN_CONTENT_MEDIA_TAG_H__
 
 #include <media_content_type.h>
 
@@ -41,15 +41,15 @@ extern "C" {
 
 /**
  * @brief Inserts a new tag in the media database.
- * @since_tizen 2.3
+ * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
  *
  * @privlevel public
  * @privilege %http://tizen.org/privilege/content.write
  *
- * @remarks The created tag handle must be released using media_tag_destroy().
+ * @remarks The @a tag should be released using media_tag_destroy().
  *
- * @param[in]  tag_name The tag name to be inserted
- * @param[out] tag      The created handle to the media tag
+ * @param[in] tag_name The tag name to be inserted
+ * @param[out] tag The handle to the media tag
  *
  * @return @c 0 on success,
  *         otherwise a negative error value
@@ -57,6 +57,10 @@ extern "C" {
  * @retval #MEDIA_CONTENT_ERROR_NONE              Successful
  * @retval #MEDIA_CONTENT_ERROR_INVALID_PARAMETER Invalid parameter
  * @retval #MEDIA_CONTENT_ERROR_OUT_OF_MEMORY     Out of memory
+ * @retval #MEDIA_CONTENT_ERROR_INVALID_OPERATION Invalid operation
+ * @retval #MEDIA_CONTENT_ERROR_DB_FAILED         DB Operation failed
+ * @retval #MEDIA_CONTENT_ERROR_DB_BUSY           DB Operation busy
+ * @retval #MEDIA_CONTENT_ERROR_NETWORK           Network fail
  * @retval #MEDIA_CONTENT_ERROR_PERMISSION_DENIED Permission denied
  *
  * @pre This function requires opened connection to content service by media_content_connect().
@@ -69,18 +73,22 @@ int media_tag_insert_to_db(const char *tag_name, media_tag_h *tag);
 
 /**
  * @brief Deletes a given tag from the media database.
- * @since_tizen 2.3
+ * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
  *
  * @privlevel public
  * @privilege %http://tizen.org/privilege/content.write
  *
- * @param[in] tag_id The ID of media tag
+ * @param[in] tag_id The ID of the media tag
  *
  * @return @c 0 on success,
  *         otherwise a negative error value
  *
  * @retval #MEDIA_CONTENT_ERROR_NONE              Successful
  * @retval #MEDIA_CONTENT_ERROR_INVALID_PARAMETER Invalid parameter
+ * @retval #MEDIA_CONTENT_ERROR_INVALID_OPERATION Invalid operation
+ * @retval #MEDIA_CONTENT_ERROR_DB_FAILED         DB Operation failed
+ * @retval #MEDIA_CONTENT_ERROR_DB_BUSY           DB Operation busy
+ * @retval #MEDIA_CONTENT_ERROR_NETWORK           Network fail
  * @retval #MEDIA_CONTENT_ERROR_PERMISSION_DENIED Permission denied
  *
  * @pre This function requires opened connection to content service by media_content_connect().
@@ -92,9 +100,9 @@ int media_tag_delete_from_db(int tag_id);
 
 /**
  * @brief Gets the count of the tag for the passed @a filter from the media database.
- * @since_tizen 2.3
+ * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
  *
- * @param[in]  filter    The handle to the filter
+ * @param[in] filter The handle to the media filter
  * @param[out] tag_count The count of the media tag
  *
  * @return @c 0 on success,
@@ -102,8 +110,8 @@ int media_tag_delete_from_db(int tag_id);
  *
  * @retval #MEDIA_CONTENT_ERROR_NONE              Successful
  * @retval #MEDIA_CONTENT_ERROR_INVALID_PARAMETER Invalid parameter
- * @retval #MEDIA_CONTENT_ERROR_DB_FAILED         DB operation failed
- * @retval #MEDIA_CONTENT_ERROR_PERMISSION_DENIED Permission denied
+ * @retval #MEDIA_CONTENT_ERROR_DB_FAILED         DB Operation failed
+ * @retval #MEDIA_CONTENT_ERROR_DB_BUSY           DB Operation busy
  *
  * @pre This function requires opened connection to content service by media_content_connect().
  *
@@ -117,19 +125,20 @@ int media_tag_get_tag_count_from_db(filter_h filter, int *tag_count);
  *          and calls a registered callback function for every retrieved tag.
  *          If @c NULL is passed to the @a filter, no filtering is applied.
  *
- * @since_tizen 2.3
+ * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
  *
- * @param[in] filter    The tag filter handle
- * @param[in] callback  The callback function to be invoked
+ * @param[in] filter The handle to the media filter
+ * @param[in] callback The callback function to be invoked
  * @param[in] user_data The user data to be passed to the callback function
  *
  * @return @c 0 on success,
  *         otherwise a negative error value
  *
  * @retval #MEDIA_CONTENT_ERROR_NONE              Successful
- * @retval #MEDIA_CONTENT_ERROR_OUT_OF_MEMORY     Out of memory
  * @retval #MEDIA_CONTENT_ERROR_INVALID_PARAMETER Invalid parameter
- * @retval #MEDIA_CONTENT_ERROR_PERMISSION_DENIED Permission denied
+ * @retval #MEDIA_CONTENT_ERROR_OUT_OF_MEMORY     Out of memory
+ * @retval #MEDIA_CONTENT_ERROR_DB_FAILED         DB Operation failed
+ * @retval #MEDIA_CONTENT_ERROR_DB_BUSY           DB Operation busy
  *
  * @pre  This function requires opened connection to content service by media_content_connect().
  * @post This function invokes media_tag_cb().
@@ -138,14 +147,14 @@ int media_tag_get_tag_count_from_db(filter_h filter, int *tag_count);
  * @see #media_tag_cb
  * @see media_filter_create()
  */
-int media_tag_foreach_tag_from_db (filter_h filter, media_tag_cb callback, void *user_data);
+int media_tag_foreach_tag_from_db(filter_h filter, media_tag_cb callback, void *user_data);
 
 /**
- * @brief Gets the number of media files for the passed @a filter in the given @a tag from the media database.
- * @since_tizen 2.3
+ * @brief Gets the number of media files for the passed @a filter in the given @a tag_id from the media database.
+ * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
  *
- * @param[in]  tag_id      The ID of the media tag
- * @param[in]  filter      The handle to the media filter
+ * @param[in] tag_id The ID of the media tag
+ * @param[in] filter The handle to the media filter
  * @param[out] media_count The count of media items
  *
  * @return @c 0 on success,
@@ -153,14 +162,14 @@ int media_tag_foreach_tag_from_db (filter_h filter, media_tag_cb callback, void
  *
  * @retval #MEDIA_CONTENT_ERROR_NONE              Successful
  * @retval #MEDIA_CONTENT_ERROR_INVALID_PARAMETER Invalid parameter
- * @retval #MEDIA_CONTENT_ERROR_DB_FAILED         DB operation failed
- * @retval #MEDIA_CONTENT_ERROR_PERMISSION_DENIED Permission denied
+ * @retval #MEDIA_CONTENT_ERROR_DB_FAILED         DB Operation failed
+ * @retval #MEDIA_CONTENT_ERROR_DB_BUSY           DB Operation busy
  *
  * @pre This function requires opened connection to content service by media_content_connect().
  *
  * @see media_content_connect()
  */
-int media_tag_get_media_count_from_db (int tag_id, filter_h filter, int *media_count);
+int media_tag_get_media_count_from_db(int tag_id, filter_h filter, int *media_count);
 
 /**
  * @brief Iterates through media items for a given tag from the media database.
@@ -168,11 +177,11 @@ int media_tag_get_media_count_from_db (int tag_id, filter_h filter, int *media_c
  *          meeting a desired @a filter and calls a registered callback function for
  *          every retrieved media item. If @c NULL is passed to the @a filter, no filtering is applied.
  *
- * @since_tizen 2.3
+ * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
  *
- * @param[in] tag_id    The ID of the media tag
- * @param[in] filter    The handle to the media filter
- * @param[in] callback  The callback function to be invoked
+ * @param[in] tag_id The ID of the media tag
+ * @param[in] filter The handle to the media filter
+ * @param[in] callback The callback function to be invoked
  * @param[in] user_data The user data to be passed to the callback function
  *
  * @return @c 0 on success,
@@ -181,7 +190,8 @@ int media_tag_get_media_count_from_db (int tag_id, filter_h filter, int *media_c
  * @retval #MEDIA_CONTENT_ERROR_NONE              Successful
  * @retval #MEDIA_CONTENT_ERROR_INVALID_PARAMETER Invalid parameter
  * @retval #MEDIA_CONTENT_ERROR_OUT_OF_MEMORY     Out of memory
- * @retval #MEDIA_CONTENT_ERROR_PERMISSION_DENIED Permission denied
+ * @retval #MEDIA_CONTENT_ERROR_DB_FAILED         DB Operation failed
+ * @retval #MEDIA_CONTENT_ERROR_DB_BUSY           DB Operation busy
  *
  * @pre  This function requires opened connection to content service by media_content_connect().
  * @post This function invokes media_info_cb().
@@ -195,16 +205,16 @@ int media_tag_foreach_media_from_db(int tag_id, filter_h filter, media_info_cb c
 /**
  * @brief Clones the media tag.
  * @details This function copies the media tag handle from a source to destination.
- *          There is no media_tag_create() function. The media_tag_h is created internally and available through media tag foreach function
+ *          There is no media_tag_create() function. The #media_tag_h is created internally and available through media tag foreach function
  *          such as media_tag_foreach_tag_from_db().
  *          To use this handle outside of these foreach functions, use this function.
  *
- * @since_tizen 2.3
+ * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
  *
- * @remarks You must release the destination handle using media_tag_destroy().
+ * @remarks The @a dst should be released using media_tag_destroy().
  *
  * @param[out] dst The destination handle to the media tag
- * @param[in]  src The source handle to the media tag
+ * @param[in] src The source handle to the media tag
  *
  * @return @c 0 on success,
  *         otherwise a negative error value
@@ -212,7 +222,6 @@ int media_tag_foreach_media_from_db(int tag_id, filter_h filter, media_info_cb c
  * @retval #MEDIA_CONTENT_ERROR_NONE              Successful
  * @retval #MEDIA_CONTENT_ERROR_OUT_OF_MEMORY     Out of memory
  * @retval #MEDIA_CONTENT_ERROR_INVALID_PARAMETER Invalid parameter
- * @retval #MEDIA_CONTENT_ERROR_PERMISSION_DENIED Permission denied
  *
  * @see media_tag_destroy()
  */
@@ -221,18 +230,17 @@ int media_tag_clone(media_tag_h *dst, media_tag_h src);
 /**
  * @brief Destroys the media tag.
  * @details This function frees all resources related to the tag handle. The tag handle can no longer
- *          be used for any operation. A new tag handle has to be created before next usage.
+ *          be used for any operations. A new tag handle has to be created before next usage.
  *
- * @since_tizen 2.3
+ * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
  *
- * @param[in] tag The media tag handle
+ * @param[in] tag The handle to the media tag
  *
  * @return @c 0 on success,
  *         otherwise a negative error value
  *
  * @retval #MEDIA_CONTENT_ERROR_NONE              Successful
  * @retval #MEDIA_CONTENT_ERROR_INVALID_PARAMETER Invalid parameter
- * @retval #MEDIA_CONTENT_ERROR_PERMISSION_DENIED Permission denied
  *
  * @pre A copy of the media tag handle created by calling media_tag_clone() or media_tag_insert_to_db().
  *
@@ -243,28 +251,27 @@ int media_tag_destroy(media_tag_h tag);
 
 /**
  * @brief Gets the media tag ID.
- * @since_tizen 2.3
+ * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
  *
- * @param[in]  tag     The media tag handle
- * @param[out] tag_id  The ID of the media tag
+ * @param[in] tag The handle to the media tag
+ * @param[out] tag_id The ID of the media tag
  *
  * @return @c 0 on success,
  *         otherwise a negative error value
  *
  * @retval #MEDIA_CONTENT_ERROR_NONE              Successful
  * @retval #MEDIA_CONTENT_ERROR_INVALID_PARAMETER Invalid parameter
- * @retval #MEDIA_CONTENT_ERROR_PERMISSION_DENIED Permission denied
  */
 int media_tag_get_tag_id(media_tag_h tag, int *tag_id);
 
 /**
  * @brief Gets the tag name.
- * @since_tizen 2.3
+ * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
  *
- * @remarks You must release @a tag_name using free().
+ * @remarks The @a tag_name should be released using free().
  *
- * @param[in]  tag      The media tag handle
- * @param[out] tag_name The name of the tag
+ * @param[in] tag The handle to the media tag
+ * @param[out] tag_name The name of the media tag
  *
  * @return @c 0 on success,
  *         otherwise a negative error value
@@ -272,7 +279,6 @@ int media_tag_get_tag_id(media_tag_h tag, int *tag_id);
  * @retval #MEDIA_CONTENT_ERROR_NONE              Successful
  * @retval #MEDIA_CONTENT_ERROR_INVALID_PARAMETER Invalid parameter
  * @retval #MEDIA_CONTENT_ERROR_OUT_OF_MEMORY     Out of memory
- * @retval #MEDIA_CONTENT_ERROR_PERMISSION_DENIED Permission denied
  */
 int media_tag_get_name(media_tag_h tag, char **tag_name);
 
@@ -282,19 +288,21 @@ int media_tag_get_name(media_tag_h tag, char **tag_name);
  * @details This function creates a new media tag handle from the media database by the given @a tag_id.
  *          Media tag will be created and will be filled with tag information.
  *
- * @since_tizen 2.3
+ * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
  *
- * @remarks You must release @a folder using media_tag_destroy().
+ * @remarks The @a tag should be released using media_tag_destroy().
  *
- * @param[in]  tag_id The ID of the media tag
- * @param[out] tag    The media tag handle associated with the tag ID
+ * @param[in] tag_id The ID of the media tag
+ * @param[out] tag The handle to the media tag
  *
  * @return @c 0 on success,
  *         otherwise a negative error value
  *
  * @retval #MEDIA_CONTENT_ERROR_NONE              Successful
  * @retval #MEDIA_CONTENT_ERROR_INVALID_PARAMETER Invalid parameter
- * @retval #MEDIA_CONTENT_ERROR_PERMISSION_DENIED Permission denied
+ * @retval #MEDIA_CONTENT_ERROR_OUT_OF_MEMORY     Out of memory
+ * @retval #MEDIA_CONTENT_ERROR_DB_FAILED         DB Operation failed
+ * @retval #MEDIA_CONTENT_ERROR_DB_BUSY           DB Operation busy
  *
  * @pre This function requires opened connection to content service by media_content_connect().
  *
@@ -305,10 +313,10 @@ int media_tag_get_tag_from_db(int tag_id, media_tag_h *tag);
 
 /**
  * @brief Adds a new media info to the tag.
- * @since_tizen 2.3
+ * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
  *
- * @param[in] tag      The media tag handle
- * @param[in] media_id The ID to the media info which is added
+ * @param[in] tag The handle to the media tag
+ * @param[in] media_id The media ID
  *
  * @return @c 0 on success,
  *         otherwise a negative error value
@@ -316,7 +324,6 @@ int media_tag_get_tag_from_db(int tag_id, media_tag_h *tag);
  * @retval #MEDIA_CONTENT_ERROR_NONE              Successful
  * @retval #MEDIA_CONTENT_ERROR_INVALID_PARAMETER Invalid parameter
  * @retval #MEDIA_CONTENT_ERROR_OUT_OF_MEMORY     Out of memory
- * @retval #MEDIA_CONTENT_ERROR_PERMISSION_DENIED Permission denied
  *
  * @pre  This function requires opened connection to content service by media_content_connect().
  * @post media_tag_update_to_db()
@@ -328,10 +335,10 @@ int media_tag_add_media(media_tag_h tag, const char *media_id);
 
 /**
  * @brief Removes the media info from the given tag.
- * @since_tizen 2.3
+ * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
  *
- * @param[in] tag      The media tag handle
- * @param[in] media_id The ID to the media info which is removed
+ * @param[in] tag The handle to the media tag
+ * @param[in] media_id The media ID
  *
  * @return @c 0 on success,
  *         otherwise a negative error value
@@ -339,7 +346,6 @@ int media_tag_add_media(media_tag_h tag, const char *media_id);
  * @retval #MEDIA_CONTENT_ERROR_NONE              Successful
  * @retval #MEDIA_CONTENT_ERROR_INVALID_PARAMETER Invalid parameter
  * @retval #MEDIA_CONTENT_ERROR_OUT_OF_MEMORY     Out of memory
- * @retval #MEDIA_CONTENT_ERROR_PERMISSION_DENIED Permission denied
  *
  * @pre  This function requires opened connection to content service by media_content_connect().
  * @post media_tag_update_to_db()
@@ -351,9 +357,9 @@ int media_tag_remove_media(media_tag_h tag, const char *media_id);
 
 /**
  * @brief Sets the name of the tag.
- * @since_tizen 2.3
+ * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
  *
- * @param[in] tag      The media tag handle
+ * @param[in] tag The handle to the media tag
  * @param[in] tag_name The name of the media tag
  *
  * @return @c 0 on success,
@@ -362,11 +368,10 @@ int media_tag_remove_media(media_tag_h tag, const char *media_id);
  * @retval #MEDIA_CONTENT_ERROR_NONE              Successful
  * @retval #MEDIA_CONTENT_ERROR_INVALID_PARAMETER Invalid parameter
  * @retval #MEDIA_CONTENT_ERROR_OUT_OF_MEMORY     Out of memory
- * @retval #MEDIA_CONTENT_ERROR_PERMISSION_DENIED Permission denied
  *
  * @post media_tag_update_to_db()
  */
-int media_tag_set_name(media_tag_h tag, char *tag_name);
+int media_tag_set_name(media_tag_h tag, const char *tag_name);
 
 /**
  * @brief Updates the media tag to the media database.
@@ -375,18 +380,24 @@ int media_tag_set_name(media_tag_h tag, char *tag_name);
  *          database. For example, after using media_tag_set_name() for setting the name of the tag, the media_tag_update_to_db() function should be called so as to update
  *          the given tag attributes in the media database.
  *
- * @since_tizen 2.3
+ * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
  *
  * @privlevel public
  * @privilege %http://tizen.org/privilege/content.write
  *
- * @param[in] tag The media tag handle
+ * @param[in] tag The handle to the media tag
  *
  * @return @c 0 on success,
  *         otherwise a negative error value
  *
  * @retval #MEDIA_CONTENT_ERROR_NONE              Successful
  * @retval #MEDIA_CONTENT_ERROR_INVALID_PARAMETER Invalid parameter
+ * @retval #MEDIA_CONTENT_ERROR_OUT_OF_MEMORY     Out of memory
+ * @retval #MEDIA_CONTENT_ERROR_INVALID_OPERATION Invalid operation
+ * @retval #MEDIA_CONTENT_ERROR_DB_FAILED         DB Operation failed
+ * @retval #MEDIA_CONTENT_ERROR_DB_BUSY           DB Operation busy
+ * @retval #MEDIA_CONTENT_ERROR_NETWORK           Network fail
+ * @retval #MEDIA_CONTENT_ERROR_PERMISSION_DENIED Permission denied
  *
  * @pre This function requires opened connection to content service by media_content_connect().
  *
@@ -406,4 +417,4 @@ int media_tag_update_to_db(media_tag_h tag);
 }
 #endif /* __cplusplus */
 
-#endif /* __TIZEN_MEDIA_TAG_H__ */
+#endif /* __TIZEN_CONTENT_MEDIA_TAG_H__ */