diff options
author | Jooseok Park <jooseok.park@samsung.com> | 2017-01-10 11:10:00 +0900 |
---|---|---|
committer | Jooseok Park <jooseok.park@samsung.com> | 2017-01-10 11:11:55 +0900 |
commit | 71db255f45568eddb7752800d044cfff73881bfb (patch) | |
tree | 9523ef41b2c60e291a1143dfe6d98dc45a23469a /include/iotcon-list.h | |
parent | 60fe104e91501d5e92e09a785cae20cb57e9fb91 (diff) | |
download | iotcon-71db255f45568eddb7752800d044cfff73881bfb.tar.gz iotcon-71db255f45568eddb7752800d044cfff73881bfb.tar.bz2 iotcon-71db255f45568eddb7752800d044cfff73881bfb.zip |
revise API referencesubmit/tizen_3.0/20170110.045429accepted/tizen/3.0/wearable/20170111.085450accepted/tizen/3.0/tv/20170111.085427accepted/tizen/3.0/mobile/20170111.085413accepted/tizen/3.0/ivi/20170111.085503accepted/tizen/3.0/common/20170111.161603
Change-Id: Iebd640dc8b8ef0768d5c19b2eae1b90ea479b5e6
Diffstat (limited to 'include/iotcon-list.h')
-rw-r--r-- | include/iotcon-list.h | 579 |
1 files changed, 245 insertions, 334 deletions
diff --git a/include/iotcon-list.h b/include/iotcon-list.h index 0c9b114..e246f5b 100644 --- a/include/iotcon-list.h +++ b/include/iotcon-list.h @@ -13,27 +13,28 @@ * See the License for the specific language governing permissions and * limitations under the License. */ + + #ifndef __IOTCON_STRUCT_LIST_H__ #define __IOTCON_STRUCT_LIST_H__ + #include <iotcon-types.h> + /** * @file iotcon-list.h */ + /** * @ingroup CAPI_IOT_CONNECTIVITY_COMMON_REPRESENTATION_ATTRIBUTES_MODULE * @defgroup CAPI_IOT_CONNECTIVITY_COMMON_REPRESENTATION_ATTRIBUTES_LIST_MODULE List - * * @brief IoTCon List provides API to get data from list and set data to list. - * * @section CAPI_IOT_CONNECTIVITY_COMMON_REPRESENTATION_ATTRIBUTES_LIST_MODULE_HEADER Required Header - * \#include <iotcon.h> - * + * \#include <iotcon.h> * @section CAPI_IOT_CONNECTIVITY_COMMON_REPRESENTATION_ATTRIBUTES_LIST_MODULE_OVERVIEW Overview - * The iotcon list API provides list of bool, integer, double, string, byte string, list and attributes handle. - * + * The IoTCon list API provides list of bool, integer, double, string, byte string, list and attributes handle. * Example : * @code static void _request_handler(iotcon_resource_h resource, iotcon_request_h request, @@ -152,676 +153,586 @@ static void _request_handler(iotcon_resource_h resource, iotcon_request_h reques ... } * @endcode - * * @section CAPI_IOT_CONNECTIVITY_COMMON_REPRESENTATION_ATTRIBUTES_LIST_MODULE_FEATURE Related Features - * This API is related with the following features:\n - * - http://tizen.org/feature/iot.ocf\n - * - * It is recommended to design feature related codes in your application for reliability.\n - * - * You can check if a device supports the related features for this API by using @ref CAPI_SYSTEM_SYSTEM_INFO_MODULE, thereby controlling the procedure of your application.\n - * - * To ensure your application is only running on the device with specific features, please define the features in your manifest file using the manifest editor in the SDK.\n - * - * More details on featuring your application can be found from <a href="https://developer.tizen.org/development/tools/native-tools/manifest-text-editor#feature"><b>Feature Element</b>.</a> - * + * This API is related with the following features: \n + * - http://tizen.org/feature/iot.ocf \n + * It is recommended to design feature related codes in your application for reliability. \n + * You can check if a device supports the related features for this API by using @ref CAPI_SYSTEM_SYSTEM_INFO_MODULE, thereby controlling the procedure of your application. \n + * To ensure your application is only running on the device with specific features, please define the features in your manifest file using the manifest editor in the SDK. \n + * More details on featuring your application can be found from <a href="https://developer.tizen.org/development/tools/native-tools/manifest-text-editor#feature"><b>Feature Element</b>.</a> * @{ */ + /** * @brief Creates a new list handle. - * * @since_tizen 3.0 - * - * @remarks You must destroy @a list by calling iotcon_list_destroy() - * if @a list is no longer needed. - * + * @remarks You must destroy @a list by calling iotcon_list_destroy() if @a list is no longer needed. * @param[in] type The type of list * @param[out] list A newly allocated list handle - * - * @return 0 on success, otherwise a negative error value. - * @retval #IOTCON_ERROR_NONE Successful - * @retval #IOTCON_ERROR_NOT_SUPPORTED Not supported - * @retval #IOTCON_ERROR_OUT_OF_MEMORY Out of memory - * @retval #IOTCON_ERROR_INVALID_PARAMETER Invalid parameter - * @retval #IOTCON_ERROR_INVALID_TYPE Invalid type + * @return @c 0 on success, + * otherwise a negative error value + * @retval #IOTCON_ERROR_NONE Successful + * @retval #IOTCON_ERROR_NOT_SUPPORTED Not supported + * @retval #IOTCON_ERROR_OUT_OF_MEMORY Out of memory + * @retval #IOTCON_ERROR_INVALID_PARAMETER Invalid parameter + * @retval #IOTCON_ERROR_INVALID_TYPE Invalid type */ int iotcon_list_create(iotcon_type_e type, iotcon_list_h *list); + /** * @brief Destroys a list handle. * @details Releases a @a list and its internal data. - * * @since_tizen 3.0 - * * @param[in] list The handle to the list - * - * @return 0 on success, otherwise a negative error value. - * @retval #IOTCON_ERROR_NONE Successful - * @retval #IOTCON_ERROR_NOT_SUPPORTED Not supported - * @retval #IOTCON_ERROR_INVALID_PARAMETER Invalid parameter + * @return @c 0 on success, + * otherwise a negative error value + * @retval #IOTCON_ERROR_NONE Successful + * @retval #IOTCON_ERROR_NOT_SUPPORTED Not supported + * @retval #IOTCON_ERROR_INVALID_PARAMETER Invalid parameter */ int iotcon_list_destroy(iotcon_list_h list); + /** * @brief Adds a new element integer value into the list at the given position. - * @details If @a pos is negative, or is larger than the number of elements in the list, - * the new value is added on to the end of the list. - * + * @details If @a pos is negative, or is larger than the number of elements in the list, the new value is added on to the end of the list. * @since_tizen 3.0 - * * @param[in] list The list handle * @param[in] val The new integer value * @param[in] pos The position to insert value - * - * @return 0 on success, otherwise a negative error value. - * @retval #IOTCON_ERROR_NONE Successful - * @retval #IOTCON_ERROR_NOT_SUPPORTED Not supported - * @retval #IOTCON_ERROR_OUT_OF_MEMORY Out of memory - * @retval #IOTCON_ERROR_INVALID_PARAMETER Invalid parameter - * @retval #IOTCON_ERROR_INVALID_TYPE Invalid type + * @return @c 0 on success, + * otherwise a negative error value + * @retval #IOTCON_ERROR_NONE Successful + * @retval #IOTCON_ERROR_NOT_SUPPORTED Not supported + * @retval #IOTCON_ERROR_OUT_OF_MEMORY Out of memory + * @retval #IOTCON_ERROR_INVALID_PARAMETER Invalid parameter + * @retval #IOTCON_ERROR_INVALID_TYPE Invalid type */ int iotcon_list_add_int(iotcon_list_h list, int val, int pos); + /** * @brief Adds a new element boolean value into the list at the given position. - * @details If @a pos is negative, or is larger than the number of elements in the list, - * the new value is added on to the end of the list. - * + * @details If @a pos is negative, or is larger than the number of elements in the list, the new value is added on to the end of the list. * @since_tizen 3.0 - * * @param[in] list The list handle * @param[in] val The new boolean value * @param[in] pos The position to insert value - * - * @return 0 on success, otherwise a negative error value. - * @retval #IOTCON_ERROR_NONE Successful - * @retval #IOTCON_ERROR_NOT_SUPPORTED Not supported - * @retval #IOTCON_ERROR_OUT_OF_MEMORY Out of memory - * @retval #IOTCON_ERROR_INVALID_PARAMETER Invalid parameter - * @retval #IOTCON_ERROR_INVALID_TYPE Invalid type + * @return @c 0 on success, + * otherwise a negative error value + * @retval #IOTCON_ERROR_NONE Successful + * @retval #IOTCON_ERROR_NOT_SUPPORTED Not supported + * @retval #IOTCON_ERROR_OUT_OF_MEMORY Out of memory + * @retval #IOTCON_ERROR_INVALID_PARAMETER Invalid parameter + * @retval #IOTCON_ERROR_INVALID_TYPE Invalid type */ int iotcon_list_add_bool(iotcon_list_h list, bool val, int pos); + /** * @brief Adds a new element double value into the list at the given position. - * @details If @a pos is negative, or is larger than the number of elements in the list, - * the new value is added on to the end of the list. - * + * @details If @a pos is negative, or is larger than the number of elements in the list, the new value is added on to the end of the list. * @since_tizen 3.0 - * * @param[in] list The list handle * @param[in] val The new double value * @param[in] pos The position to insert value - * - * @return 0 on success, otherwise a negative error value. - * @retval #IOTCON_ERROR_NONE Successful - * @retval #IOTCON_ERROR_NOT_SUPPORTED Not supported - * @retval #IOTCON_ERROR_OUT_OF_MEMORY Out of memory - * @retval #IOTCON_ERROR_INVALID_PARAMETER Invalid parameter - * @retval #IOTCON_ERROR_INVALID_TYPE Invalid type + * @return @c 0 on success, + * otherwise a negative error value + * @retval #IOTCON_ERROR_NONE Successful + * @retval #IOTCON_ERROR_NOT_SUPPORTED Not supported + * @retval #IOTCON_ERROR_OUT_OF_MEMORY Out of memory + * @retval #IOTCON_ERROR_INVALID_PARAMETER Invalid parameter + * @retval #IOTCON_ERROR_INVALID_TYPE Invalid type */ int iotcon_list_add_double(iotcon_list_h list, double val, int pos); + /** * @brief Adds a new element string value into the list at the given position. - * @details If @a pos is negative, or is larger than the number of elements in the list, - * the new value is added on to the end of the list. - * + * @details If @a pos is negative, or is larger than the number of elements in the list, the new value is added on to the end of the list. * @since_tizen 3.0 - * * @param[in] list The list handle * @param[in] val The new char value * @param[in] pos The position to insert value - * - * @return 0 on success, otherwise a negative error value. - * @retval #IOTCON_ERROR_NONE Successful - * @retval #IOTCON_ERROR_NOT_SUPPORTED Not supported - * @retval #IOTCON_ERROR_OUT_OF_MEMORY Out of memory - * @retval #IOTCON_ERROR_INVALID_PARAMETER Invalid parameter - * @retval #IOTCON_ERROR_INVALID_TYPE Invalid type + * @return @c 0 on success, + * otherwise a negative error value + * @retval #IOTCON_ERROR_NONE Successful + * @retval #IOTCON_ERROR_NOT_SUPPORTED Not supported + * @retval #IOTCON_ERROR_OUT_OF_MEMORY Out of memory + * @retval #IOTCON_ERROR_INVALID_PARAMETER Invalid parameter + * @retval #IOTCON_ERROR_INVALID_TYPE Invalid type */ int iotcon_list_add_str(iotcon_list_h list, char *val, int pos); + /** * @brief Adds a new element byte string value into the list at the given position. - * @details If @a pos is negative, or is larger than the number of elements in the list, - * the new value is added on to the end of the list. - * + * @details If @a pos is negative, or is larger than the number of elements in the list, the new value is added on to the end of the list. * @since_tizen 3.0 - * * @param[in] list The list handle * @param[in] val The new byte string value * @param[in] len The length of @a val * @param[in] pos The position to insert value - * - * @return 0 on success, otherwise a negative error value. - * @retval #IOTCON_ERROR_NONE Successful - * @retval #IOTCON_ERROR_NOT_SUPPORTED Not supported - * @retval #IOTCON_ERROR_OUT_OF_MEMORY Out of memory - * @retval #IOTCON_ERROR_INVALID_PARAMETER Invalid parameter - * @retval #IOTCON_ERROR_INVALID_TYPE Invalid type + * @return @c 0 on success, + * otherwise a negative error value + * @retval #IOTCON_ERROR_NONE Successful + * @retval #IOTCON_ERROR_NOT_SUPPORTED Not supported + * @retval #IOTCON_ERROR_OUT_OF_MEMORY Out of memory + * @retval #IOTCON_ERROR_INVALID_PARAMETER Invalid parameter + * @retval #IOTCON_ERROR_INVALID_TYPE Invalid type */ int iotcon_list_add_byte_str(iotcon_list_h list, unsigned char *val, int len, int pos); + /** * @brief Adds a new element list into the list at the given position. - * @details If @a pos is negative, or is larger than the number of elements in the list, - * the new value is added on to the end of the list. - * + * @details If @a pos is negative, or is larger than the number of elements in the list, the new value is added on to the end of the list. * @since_tizen 3.0 - * * @param[in] list The list handle * @param[in] val The new list value * @param[in] pos The position to insert value - * - * @return 0 on success, otherwise a negative error value. - * @retval #IOTCON_ERROR_NONE Successful - * @retval #IOTCON_ERROR_NOT_SUPPORTED Not supported - * @retval #IOTCON_ERROR_OUT_OF_MEMORY Out of memory - * @retval #IOTCON_ERROR_INVALID_PARAMETER Invalid parameter - * @retval #IOTCON_ERROR_INVALID_TYPE Invalid type + * @return @c 0 on success, + * otherwise a negative error value + * @retval #IOTCON_ERROR_NONE Successful + * @retval #IOTCON_ERROR_NOT_SUPPORTED Not supported + * @retval #IOTCON_ERROR_OUT_OF_MEMORY Out of memory + * @retval #IOTCON_ERROR_INVALID_PARAMETER Invalid parameter + * @retval #IOTCON_ERROR_INVALID_TYPE Invalid type */ int iotcon_list_add_list(iotcon_list_h list, iotcon_list_h val, int pos); /** * @brief Adds a new element attributes value into the list at the given position. - * @details If @a pos is negative, or is larger than the number of elements in the list, - * the new value is added on to the end of the list. - * + * @details If @a pos is negative, or is larger than the number of elements in the list, the new value is added on to the end of the list. * @since_tizen 3.0 - * * @param[in] list The list handle * @param[in] val The new attributes value * @param[in] pos The position to insert value - * - * @return 0 on success, otherwise a negative error value. - * @retval #IOTCON_ERROR_NONE Successful - * @retval #IOTCON_ERROR_NOT_SUPPORTED Not supported - * @retval #IOTCON_ERROR_OUT_OF_MEMORY Out of memory - * @retval #IOTCON_ERROR_INVALID_PARAMETER Invalid parameter - * @retval #IOTCON_ERROR_INVALID_TYPE Invalid type + * @return @c 0 on success, + * otherwise a negative error value + * @retval #IOTCON_ERROR_NONE Successful + * @retval #IOTCON_ERROR_NOT_SUPPORTED Not supported + * @retval #IOTCON_ERROR_OUT_OF_MEMORY Out of memory + * @retval #IOTCON_ERROR_INVALID_PARAMETER Invalid parameter + * @retval #IOTCON_ERROR_INVALID_TYPE Invalid type */ int iotcon_list_add_attributes(iotcon_list_h list, iotcon_attributes_h val, int pos); + /** * @brief Gets the integer value at the given position. * @details Iterates over the list until it reaches the @a pos-1 position. - * * @since_tizen 3.0 - * * @param[in] list The list handle * @param[in] pos The position * @param[out] val The integer value to get - * - * @return 0 on success, otherwise a negative error value. - * @retval #IOTCON_ERROR_NONE Successful - * @retval #IOTCON_ERROR_NOT_SUPPORTED Not supported - * @retval #IOTCON_ERROR_INVALID_PARAMETER Invalid parameter - * @retval #IOTCON_ERROR_NO_DATA No data available - * @retval #IOTCON_ERROR_REPRESENTATION Representation errors + * @return @c 0 on success, + * otherwise a negative error value + * @retval #IOTCON_ERROR_NONE Successful + * @retval #IOTCON_ERROR_NOT_SUPPORTED Not supported + * @retval #IOTCON_ERROR_INVALID_PARAMETER Invalid parameter + * @retval #IOTCON_ERROR_NO_DATA No data available + * @retval #IOTCON_ERROR_REPRESENTATION Representation errors */ int iotcon_list_get_nth_int(iotcon_list_h list, int pos, int *val); + /** * @brief Gets the boolean value at the given position. * @details Iterates over the list until it reaches the @a pos-1 position. - * * @since_tizen 3.0 - * * @param[in] list The list handle * @param[in] pos The position * @param[out] val The boolean value to get - * - * @return 0 on success, otherwise a negative error value. - * @retval #IOTCON_ERROR_NONE Successful - * @retval #IOTCON_ERROR_NOT_SUPPORTED Not supported - * @retval #IOTCON_ERROR_INVALID_PARAMETER Invalid parameter - * @retval #IOTCON_ERROR_NO_DATA No data available - * @retval #IOTCON_ERROR_REPRESENTATION Representation errors + * @return @c 0 on success, + * otherwise a negative error value + * @retval #IOTCON_ERROR_NONE Successful + * @retval #IOTCON_ERROR_NOT_SUPPORTED Not supported + * @retval #IOTCON_ERROR_INVALID_PARAMETER Invalid parameter + * @retval #IOTCON_ERROR_NO_DATA No data available + * @retval #IOTCON_ERROR_REPRESENTATION Representation errors */ int iotcon_list_get_nth_bool(iotcon_list_h list, int pos, bool *val); + /** * @brief Gets the double value at the given position. * @details Iterates over the list until it reaches the @a pos-1 position. - * * @since_tizen 3.0 - * * @param[in] list The list handle * @param[in] pos The position * @param[out] val The double value to get - * - * @return 0 on success, otherwise a negative error value. - * @retval #IOTCON_ERROR_NONE Successful - * @retval #IOTCON_ERROR_NOT_SUPPORTED Not supported - * @retval #IOTCON_ERROR_INVALID_PARAMETER Invalid parameter - * @retval #IOTCON_ERROR_NO_DATA No data available - * @retval #IOTCON_ERROR_REPRESENTATION Representation errors + * @return @c 0 on success, + * otherwise a negative error value + * @retval #IOTCON_ERROR_NONE Successful + * @retval #IOTCON_ERROR_NOT_SUPPORTED Not supported + * @retval #IOTCON_ERROR_INVALID_PARAMETER Invalid parameter + * @retval #IOTCON_ERROR_NO_DATA No data available + * @retval #IOTCON_ERROR_REPRESENTATION Representation errors */ int iotcon_list_get_nth_double(iotcon_list_h list, int pos, double *val); + /** * @brief Gets the string value at the given position. * @details Iterates over the list until it reaches the @a pos-1 position. - * * @since_tizen 3.0 - * * @remarks @a val must not be released using free(). - * * @param[in] list The list handle * @param[in] pos The position * @param[out] val The string value to get - * - * @return 0 on success, otherwise a negative error value. - * @retval #IOTCON_ERROR_NONE Successful - * @retval #IOTCON_ERROR_NOT_SUPPORTED Not supported - * @retval #IOTCON_ERROR_INVALID_PARAMETER Invalid parameter - * @retval #IOTCON_ERROR_NO_DATA No data available - * @retval #IOTCON_ERROR_REPRESENTATION Representation errors + * @return @c 0 on success, + * otherwise a negative error value + * @retval #IOTCON_ERROR_NONE Successful + * @retval #IOTCON_ERROR_NOT_SUPPORTED Not supported + * @retval #IOTCON_ERROR_INVALID_PARAMETER Invalid parameter + * @retval #IOTCON_ERROR_NO_DATA No data available + * @retval #IOTCON_ERROR_REPRESENTATION Representation errors */ int iotcon_list_get_nth_str(iotcon_list_h list, int pos, char **val); + /** * @brief Gets the string value at the given position. * @details Iterates over the list until it reaches the @a pos-1 position. - * * @since_tizen 3.0 - * * @remarks @a val must not be released using free(). - * * @param[in] list The list handle * @param[in] pos The position * @param[out] val The byte string value to get * @param[out] len The length of the @a val - * - * @return 0 on success, otherwise a negative error value. - * @retval #IOTCON_ERROR_NONE Successful - * @retval #IOTCON_ERROR_NOT_SUPPORTED Not supported - * @retval #IOTCON_ERROR_INVALID_PARAMETER Invalid parameter - * @retval #IOTCON_ERROR_NO_DATA No data available - * @retval #IOTCON_ERROR_REPRESENTATION Representation errors + * @return @c 0 on success, + * otherwise a negative error value + * @retval #IOTCON_ERROR_NONE Successful + * @retval #IOTCON_ERROR_NOT_SUPPORTED Not supported + * @retval #IOTCON_ERROR_INVALID_PARAMETER Invalid parameter + * @retval #IOTCON_ERROR_NO_DATA No data available + * @retval #IOTCON_ERROR_REPRESENTATION Representation errors */ -int iotcon_list_get_nth_byte_str(iotcon_list_h list, int pos, unsigned char **val, - int *len); +int iotcon_list_get_nth_byte_str(iotcon_list_h list, int pos, unsigned char **val, int *len); + /** * @brief Gets the list value at the given position. * @details Iterates over the list until it reaches the @a pos-1 position. - * * @since_tizen 3.0 - * * @remarks @a dest must not be released using iotcon_list_destroy(). - * * @param[in] src The list handle * @param[in] pos The position * @param[out] dest The list value to get - * - * @return 0 on success, otherwise a negative error value. - * @retval #IOTCON_ERROR_NONE Successful - * @retval #IOTCON_ERROR_NOT_SUPPORTED Not supported - * @retval #IOTCON_ERROR_INVALID_PARAMETER Invalid parameter - * @retval #IOTCON_ERROR_NO_DATA No data available - * @retval #IOTCON_ERROR_REPRESENTATION Representation errors + * @return @c 0 on success, + * otherwise a negative error value + * @retval #IOTCON_ERROR_NONE Successful + * @retval #IOTCON_ERROR_NOT_SUPPORTED Not supported + * @retval #IOTCON_ERROR_INVALID_PARAMETER Invalid parameter + * @retval #IOTCON_ERROR_NO_DATA No data available + * @retval #IOTCON_ERROR_REPRESENTATION Representation errors */ int iotcon_list_get_nth_list(iotcon_list_h src, int pos, iotcon_list_h *dest); + /** * @brief Gets the attributes value at the given position. * @details Iterates over the list until it reaches the @a pos-1 position. - * * @since_tizen 3.0 - * * @remarks @a attributes must not be released using iotcon_attributes_destroy(). - * * @param[in] list The list handle * @param[in] pos The position * @param[out] attributes The attributes value to get - * - * @return 0 on success, otherwise a negative error value. - * @retval #IOTCON_ERROR_NONE Successful - * @retval #IOTCON_ERROR_NOT_SUPPORTED Not supported - * @retval #IOTCON_ERROR_INVALID_PARAMETER Invalid parameter - * @retval #IOTCON_ERROR_NO_DATA No data available - * @retval #IOTCON_ERROR_REPRESENTATION Representation errors + * @return @c 0 on success, + * otherwise a negative error value + * @retval #IOTCON_ERROR_NONE Successful + * @retval #IOTCON_ERROR_NOT_SUPPORTED Not supported + * @retval #IOTCON_ERROR_INVALID_PARAMETER Invalid parameter + * @retval #IOTCON_ERROR_NO_DATA No data available + * @retval #IOTCON_ERROR_REPRESENTATION Representation errors */ int iotcon_list_get_nth_attributes(iotcon_list_h list, int pos, iotcon_attributes_h *attributes); + /** * @brief Removes the value at the given position. * @details Iterates over the list until it reaches the @a pos-1 position. - * * @since_tizen 3.0 - * * @param[in] list The list handle * @param[in] pos The position to delete - * - * @return 0 on success, otherwise a negative error value. - * @retval #IOTCON_ERROR_NONE Successful - * @retval #IOTCON_ERROR_NOT_SUPPORTED Not supported - * @retval #IOTCON_ERROR_INVALID_PARAMETER Invalid parameter - * @retval #IOTCON_ERROR_NO_DATA No data available + * @return @c 0 on success, + * otherwise a negative error value + * @retval #IOTCON_ERROR_NONE Successful + * @retval #IOTCON_ERROR_NOT_SUPPORTED Not supported + * @retval #IOTCON_ERROR_INVALID_PARAMETER Invalid parameter + * @retval #IOTCON_ERROR_NO_DATA No data available */ int iotcon_list_remove_nth(iotcon_list_h list, int pos); + /** * @brief Gets the type of the list. - * @details It gets the data type of value related the @a key in @a attributes. - * The data type could be one of #iotcon_type_e. - * + * @details It gets the data type of value related to the @a key in @a attributes. + * The data type could be one of #iotcon_type_e. * @since_tizen 3.0 - * * @param[in] list The list handle - * @param[out] type The data type of list. - * - * @return 0 on success, otherwise a negative error value. - * @retval #IOTCON_ERROR_NONE Successful - * @retval #IOTCON_ERROR_NOT_SUPPORTED Not supported - * @retval #IOTCON_ERROR_INVALID_PARAMETER Invalid parameter + * @param[out] type The data type of list + * @return @c 0 on success, + * otherwise a negative error value + * @retval #IOTCON_ERROR_NONE Successful + * @retval #IOTCON_ERROR_NOT_SUPPORTED Not supported + * @retval #IOTCON_ERROR_INVALID_PARAMETER Invalid parameter */ int iotcon_list_get_type(iotcon_list_h list, iotcon_type_e *type); + /** * @brief Gets the number of elements in a list. - * * @since_tizen 3.0 - * * @param[in] list The handle to the list * @param[out] length The length of list - * - * @return 0 on success, otherwise a negative error value. - * @retval #IOTCON_ERROR_NONE Successful - * @retval #IOTCON_ERROR_NOT_SUPPORTED Not supported - * @retval #IOTCON_ERROR_INVALID_PARAMETER Invalid parameter + * @return @c 0 on success, + * otherwise a negative error value + * @retval #IOTCON_ERROR_NONE Successful + * @retval #IOTCON_ERROR_NOT_SUPPORTED Not supported + * @retval #IOTCON_ERROR_INVALID_PARAMETER Invalid parameter */ int iotcon_list_get_length(iotcon_list_h list, unsigned int *length); + /** * @brief Specifies the type of function passed to iotcon_list_foreach_int(). - * * @since_tizen 3.0 - * * @param[in] pos The number of the integer value (0 being the first) * @param[in] value The integer value * @param[in] user_data The user data to pass to the function - * - * @return true to continue with the next iteration of the loop, - * otherwise false to break out of the loop. #IOTCON_FUNC_CONTINUE and #IOTCON_FUNC_STOP - * are more friendly values for the return. - * + * @return @c true to continue with the next iteration of the loop, + * otherwise @c false to break out of the loop + * #IOTCON_FUNC_CONTINUE and #IOTCON_FUNC_STOP are more friendly values for the return * @pre iotcon_list_foreach_int() will invoke this callback function. - * * @see iotcon_list_foreach_int() */ typedef bool (*iotcon_list_int_cb)(int pos, int value, void *user_data); + /** * @brief Gets all integer values of the given list by invoking the callback function. * @details iotcon_list_int_cb() will be called for each child. - * * @since_tizen 3.0 - * * @param[in] list The handle to the list * @param[in] cb The callback function to get each integer value * @param[in] user_data The user data to be passed to the callback function - * - * @return 0 on success, otherwise a negative error value. - * @retval #IOTCON_ERROR_NONE Successful - * @retval #IOTCON_ERROR_NOT_SUPPORTED Not supported - * @retval #IOTCON_ERROR_INVALID_PARAMETER Invalid parameter - * + * @return @c 0 on success, + * otherwise a negative error value + * @retval #IOTCON_ERROR_NONE Successful + * @retval #IOTCON_ERROR_NOT_SUPPORTED Not supported + * @retval #IOTCON_ERROR_INVALID_PARAMETER Invalid parameter * @post iotcon_list_int_cb() will be called for each item. - * * @see iotcon_list_int_cb() */ int iotcon_list_foreach_int(iotcon_list_h list, iotcon_list_int_cb cb, void *user_data); + /** * @brief Specifies the type of function passed to iotcon_list_foreach_bool(). - * * @since_tizen 3.0 - * * @param[in] pos The number of the boolean value (0 being the first) * @param[in] value The boolean value * @param[in] user_data The user data to pass to the function - * - * @return true to continue with the next iteration of the loop, - * otherwise false to break out of the loop. #IOTCON_FUNC_CONTINUE and #IOTCON_FUNC_STOP - * are more friendly values for the return. - * + * @return @c true to continue with the next iteration of the loop, + * otherwise @c false to break out of the loop + * #IOTCON_FUNC_CONTINUE and #IOTCON_FUNC_STOP are more friendly values for the return * @pre iotcon_list_foreach_bool() will invoke this callback function. - * * @see iotcon_list_foreach_bool() */ typedef bool (*iotcon_list_bool_cb)(int pos, bool value, void *user_data); + /** * @brief Gets all boolean values of the given list by invoking the callback function. * @details iotcon_list_bool_cb() will be called for each child. - * * @since_tizen 3.0 - * * @param[in] list The handle to the list * @param[in] cb The callback function to get each boolean value * @param[in] user_data The user data to be passed to the callback function - * - * @return 0 on success, otherwise a negative error value. - * @retval #IOTCON_ERROR_NONE Successful - * @retval #IOTCON_ERROR_NOT_SUPPORTED Not supported - * @retval #IOTCON_ERROR_INVALID_PARAMETER Invalid parameter - * + * @return @c 0 on success, + * otherwise a negative error value + * @retval #IOTCON_ERROR_NONE Successful + * @retval #IOTCON_ERROR_NOT_SUPPORTED Not supported + * @retval #IOTCON_ERROR_INVALID_PARAMETER Invalid parameter * @post iotcon_list_bool_cb() will be called for each item. - * * @see iotcon_list_bool_cb() */ int iotcon_list_foreach_bool(iotcon_list_h list, iotcon_list_bool_cb cb, void *user_data); + /** - * @brief Specifies the type of function passed to iotcon_list_foreach_double() - * + * @brief Specifies the type of function passed to iotcon_list_foreach_double(). * @since_tizen 3.0 - * * @param[in] pos The number of the double value (0 being the first) * @param[in] value The double value * @param[in] user_data The user data to pass to the function - * - * @return true to continue with the next iteration of the loop, - * otherwise false to break out of the loop. #IOTCON_FUNC_CONTINUE and #IOTCON_FUNC_STOP - * are more friendly values for the return. - * + * @return @c true to continue with the next iteration of the loop, + * otherwise @c false to break out of the loop + * #IOTCON_FUNC_CONTINUE and #IOTCON_FUNC_STOP are more friendly values for the return * @pre iotcon_list_foreach_double() will invoke this callback function. - * * @see iotcon_list_foreach_double() */ typedef bool (*iotcon_list_double_cb)(int pos, double value, void *user_data); + /** * @brief Gets all double values of the given list by invoking the callback function. * @details iotcon_list_double_cb() will be called for each child. - * * @since_tizen 3.0 - * * @param[in] list The handle to the list * @param[in] cb The callback function to get each double value * @param[in] user_data The user data to be passed to the callback function - * - * @return 0 on success, otherwise a negative error value. - * @retval #IOTCON_ERROR_NONE Successful - * @retval #IOTCON_ERROR_NOT_SUPPORTED Not supported - * @retval #IOTCON_ERROR_INVALID_PARAMETER Invalid parameter - * + * @return @c 0 on success, + * otherwise a negative error value + * @retval #IOTCON_ERROR_NONE Successful + * @retval #IOTCON_ERROR_NOT_SUPPORTED Not supported + * @retval #IOTCON_ERROR_INVALID_PARAMETER Invalid parameter * @post iotcon_list_double_cb() will be called for each item. - * * @see iotcon_list_double_cb() */ -int iotcon_list_foreach_double(iotcon_list_h list, iotcon_list_double_cb cb, - void *user_data); +int iotcon_list_foreach_double(iotcon_list_h list, iotcon_list_double_cb cb, void *user_data); + /** * @brief Specifies the type of function passed to iotcon_list_foreach_byte_str(). - * * @since_tizen 3.0 - * * @param[in] pos The number of the string value (0 being the first) * @param[in] value The byte string value * @param[in] len The length of @a value * @param[in] user_data The user data to pass to the function - * - * @return true to continue with the next iteration of the loop, - * otherwise false to break out of the loop. #IOTCON_FUNC_CONTINUE and #IOTCON_FUNC_STOP - * are more friendly values for the return. - * + * @return @c true to continue with the next iteration of the loop, + * otherwise @c false to break out of the loop + * #IOTCON_FUNC_CONTINUE and #IOTCON_FUNC_STOP are more friendly values for the return * @pre iotcon_list_foreach_byte_str() will invoke this callback function. - * * @see iotcon_list_foreach_byte_str() */ -typedef bool (*iotcon_list_byte_str_cb)(int pos, const unsigned char *value, int len, - void *user_data); +typedef bool (*iotcon_list_byte_str_cb)(int pos, const unsigned char *value, int len, void *user_data); + /** * @brief Gets all string values of the given list by invoking the callback function. * @details iotcon_list_byte_str_cb() will be called for each child. - * * @since_tizen 3.0 - * * @param[in] list The handle to the list * @param[in] cb The callback function to get each string value * @param[in] user_data The user data to be passed to the callback function - * - * @return 0 on success, otherwise a negative error value. - * @retval #IOTCON_ERROR_NONE Successful - * @retval #IOTCON_ERROR_NOT_SUPPORTED Not supported - * @retval #IOTCON_ERROR_INVALID_PARAMETER Invalid parameter - * + * @return @c 0 on success, + * otherwise a negative error value + * @retval #IOTCON_ERROR_NONE Successful + * @retval #IOTCON_ERROR_NOT_SUPPORTED Not supported + * @retval #IOTCON_ERROR_INVALID_PARAMETER Invalid parameter * @post iotcon_list_byte_str_cb() will be called for each item. - * * @see iotcon_list_byte_str_cb() */ -int iotcon_list_foreach_byte_str(iotcon_list_h list, iotcon_list_byte_str_cb cb, - void *user_data); +int iotcon_list_foreach_byte_str(iotcon_list_h list, iotcon_list_byte_str_cb cb, void *user_data); + /** * @brief Specifies the type of function passed to iotcon_list_foreach_str(). - * * @since_tizen 3.0 - * * @param[in] pos The number of the string value (0 being the first) * @param[in] value The string value * @param[in] user_data The user data to pass to the function - * - * @return true to continue with the next iteration of the loop, - * otherwise false to break out of the loop. #IOTCON_FUNC_CONTINUE and #IOTCON_FUNC_STOP - * are more friendly values for the return. - * + * @return @c true to continue with the next iteration of the loop, + * otherwise @c false to break out of the loop + * #IOTCON_FUNC_CONTINUE and #IOTCON_FUNC_STOP are more friendly values for the return * @pre iotcon_list_foreach_str() will invoke this callback function. - * * @see iotcon_list_foreach_str() */ typedef bool (*iotcon_list_str_cb)(int pos, const char *value, void *user_data); + /** * @brief Gets all string values of the given list by invoking the callback function. * @details iotcon_list_str_cb() will be called for each child. - * * @since_tizen 3.0 - * * @param[in] list The handle to the list * @param[in] cb The callback function to get each string value * @param[in] user_data The user data to be passed to the callback function - * - * @return 0 on success, otherwise a negative error value. - * @retval #IOTCON_ERROR_NONE Successful - * @retval #IOTCON_ERROR_NOT_SUPPORTED Not supported - * @retval #IOTCON_ERROR_INVALID_PARAMETER Invalid parameter - * + * @return @c 0 on success, + * otherwise a negative error value + * @retval #IOTCON_ERROR_NONE Successful + * @retval #IOTCON_ERROR_NOT_SUPPORTED Not supported + * @retval #IOTCON_ERROR_INVALID_PARAMETER Invalid parameter * @post iotcon_list_str_cb() will be called for each item. - * * @see iotcon_list_str_cb() */ int iotcon_list_foreach_str(iotcon_list_h list, iotcon_list_str_cb cb, void *user_data); + /** * @brief Specifies the type of function passed to iotcon_list_foreach_list(). - * * @since_tizen 3.0 - * * @param[in] pos The number of the list value (0 being the first) * @param[in] value The list value * @param[in] user_data The user data to pass to the function - * - * @return true to continue with the next iteration of the loop, - * otherwise false to break out of the loop. #IOTCON_FUNC_CONTINUE and #IOTCON_FUNC_STOP - * are more friendly values for the return. - * + * @return @c true to continue with the next iteration of the loop, + * otherwise @c false to break out of the loop + * #IOTCON_FUNC_CONTINUE and #IOTCON_FUNC_STOP are more friendly values for the return * @pre iotcon_list_foreach_list() will invoke this callback function. - * * @see iotcon_list_foreach_list() */ typedef bool (*iotcon_list_list_cb)(int pos, iotcon_list_h value, void *user_data); + /** * @brief Gets all sub lists of the given list by invoking the callback function. * @details iotcon_list_list_cb() will be called for each child. - * * @since_tizen 3.0 - * * @param[in] list The handle to the origin list * @param[in] cb The callback function to get each sub list * @param[in] user_data The user data to be passed to the callback function - * - * @return 0 on success, otherwise a negative error value. - * @retval #IOTCON_ERROR_NONE Successful - * @retval #IOTCON_ERROR_NOT_SUPPORTED Not supported - * @retval #IOTCON_ERROR_INVALID_PARAMETER Invalid parameter - * + * @return @c 0 on success, + * otherwise a negative error value + * @retval #IOTCON_ERROR_NONE Successful + * @retval #IOTCON_ERROR_NOT_SUPPORTED Not supported + * @retval #IOTCON_ERROR_INVALID_PARAMETER Invalid parameter * @post iotcon_list_list_cb() will be called for each item. - * * @see iotcon_list_list_cb() */ int iotcon_list_foreach_list(iotcon_list_h list, iotcon_list_list_cb cb, void *user_data); + /** * @brief Specifies the type of function passed to iotcon_list_foreach_attributes(). - * * @since_tizen 3.0 - * * @param[in] pos The number of the attributes value (0 being the first) * @param[in] value The attributes value * @param[in] user_data The user data to pass to the function - * - * @return true to continue with the next iteration of the loop, - * otherwise false to break out of the loop. #IOTCON_FUNC_CONTINUE and #IOTCON_FUNC_STOP - * are more friendly values for the return. - * + * @return @c true to continue with the next iteration of the loop, + * otherwise @c false to break out of the loop + * #IOTCON_FUNC_CONTINUE and #IOTCON_FUNC_STOP are more friendly values for the return * @pre iotcon_list_foreach_attributes() will invoke this callback function. - * * @see iotcon_list_foreach_attributes() */ typedef bool (*iotcon_list_attributes_cb)(int pos, iotcon_attributes_h value, void *user_data); + /** * @brief Gets all attributes of the given list by invoking the callback function. * @details iotcon_list_attributes_cb() will be called for each child. - * * @since_tizen 3.0 - * * @param[in] list The handle to the list * @param[in] cb The callback function to get each attributes * @param[in] user_data The user data to be passed to the callback function - * - * @return 0 on success, otherwise a negative error value. - * @retval #IOTCON_ERROR_NONE Successful - * @retval #IOTCON_ERROR_NOT_SUPPORTED Not supported - * @retval #IOTCON_ERROR_INVALID_PARAMETER Invalid parameter - * + * @return @c 0 on success, + * otherwise a negative error value + * @retval #IOTCON_ERROR_NONE Successful + * @retval #IOTCON_ERROR_NOT_SUPPORTED Not supported + * @retval #IOTCON_ERROR_INVALID_PARAMETER Invalid parameter * @post iotcon_list_attributes_cb() will be called for each item. - * * @see iotcon_list_attributes_cb() */ int iotcon_list_foreach_attributes(iotcon_list_h list, iotcon_list_attributes_cb cb, void *user_data); + /** * @} */ + #endif /* __IOTCON_STRUCT_LIST_H__ */ |