Update the parameter description and add sample code 07/311207/4 accepted/tizen/unified/20240718.010242 accepted/tizen/unified/dev/20240718.040005 accepted/tizen/unified/x/20240718.022936
authorKrishna Kant Jaju <krishna.jaju@samsung.com>
Thu, 16 May 2024 06:07:03 +0000 (11:37 +0530)
committerKrishna Kant Jaju <krishna.jaju@samsung.com>
Thu, 16 May 2024 06:34:43 +0000 (12:04 +0530)
Change-Id: Idc52845323b8659964de941516356c46bed569e1
Signed-off-by: Krishna Kant Jaju <krishna.jaju@samsung.com>
include/account.h
packaging/libaccount-service.spec

index 6efd2480e9b5e2d51348ee3a4dd9c7b318eadd08..8b64fbb503a3062c5580019da297b353211be1a4 100644 (file)
@@ -1808,6 +1808,8 @@ int account_type_foreach_account_type_from_db(account_type_cb callback, void *us
  * @brief  Retrieves the label information with the given application ID and locale.
  *
  * @since_tizen 2.3
+ * @remarks The @a label should be released using free().
+ *
  * @privlevel   public
  * @privilege   %http://tizen.org/privilege/account.read
  * @param[in]   app_id  The application ID
@@ -1828,6 +1830,44 @@ int account_type_foreach_account_type_from_db(account_type_cb callback, void *us
  *
  * @pre  This function requires an open connection to an account service by account_connect() on tizen 2.3 .\n
  *       But the account_connect() is not required to use this function since tizen 2.4.
+ *
+ * @par Example
+ * @code
+#include <account.h>
+...
+account_h account;
+
+ret = account_connect();
+if(ret != ACCOUNT_ERROR_NONE) {
+    SECURE_LOGD("(%d)-[Account] ret = %d, account=%p\n", __LINE__, ret, account);
+}
+
+ret = account_create(&account);
+if(ret != ACCOUNT_ERROR_NONE) {
+    SECURE_LOGD("(%d)-[Account] ret = %d, account=%p\n", __LINE__, ret, account);
+}
+...
+char *app_id = "org.tizen.example";
+char *locale = "en_US.utf8";
+char *label = NULL;
+
+ret = account_type_query_label_by_locale(app_id, locale, &label);
+if (ret!= ACCOUNT_ERROR_NONE) {
+    SECURE_LOGD("(%d)-[Account] ret = %d, account=%p\n", __LINE__, ret, account);
+}
+...
+
+if (label) {
+    free(label);
+    label = NULL;
+}
+...
+ret = account_disconnect();
+if(ret != ACCOUNT_ERROR_NONE) {
+    SECURE_LOGD("(%d)-[Account] ret = %d, account=%p\n", __LINE__, ret, account);
+}
+...
+ * @endcode
  */
 int account_type_query_label_by_locale(const char *app_id, const char *locale, char **label);
 
index 35fa2b12dd97952c1441b0b62bf342788a196a5f..1ced4d3b5f26aff9639d13f44223b7299b3a3922 100644 (file)
@@ -1,6 +1,6 @@
 Name:       libaccount-service
 Summary:    Account DB library
-Version:    0.4.24
+Version:    0.4.25
 Release:    1
 Group:      Social & Content/API
 License:    Apache-2.0