include/common/common_vconf.h

   1 /*
   2  * oma-ds-agent
   3  * Copyright (c) 2012 Samsung Electronics Co., Ltd.
   4  *
   5  * Licensed under the Apache License, Version 2.0 (the License);
   6  * you may not use this file except in compliance with the License.
   7  * You may obtain a copy of the License at
   8  *
   9  *     http://www.apache.org/licenses/LICENSE-2.0
  10  *
  11  * Unless required by applicable law or agreed to in writing, software
  12  * distributed under the License is distributed on an "AS IS" BASIS,
  13  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  14  * See the License for the specific language governing permissions and
  15  * limitations under the License.
  16  */
  17
  18 /**
  19  *   @Common_Vconf.h
  20  *   @version                                                                   0.1
  21  *   @brief                                                                             This file is the header file of defined vconf value
  22  */
  23
  24 #ifndef COMMON_VCONF_H_
  25 #define COMMON_VCONF_H_
  26
  27 #include <stdbool.h>
  28
  29 /**
  30  * @par Description: API to get value(char*) from vconf
  31  *
  32  *
  33  * @par Purpose:
  34  * @par Typical use case:
  35  * @par Method of function operation:
  36  * @par Important notes:
  37  * @param[in]           string type, base key
  38  * @param[in]           string type, key
  39  * @param[out]
  40  *
  41  * @return                              value on success
  42  *                                                      NULL on error
  43  *
  44  * @par Errors:
  45  *
  46  * @pre None.
  47  * @post
  48  * @see
  49  * @remarks None.
  50  *
  51  * @par Sample Code:
  52  * @code
  53  * @endcode
  54  */
  55 char *get_vconf_str(char *base_key, char *key);
  56
  57 /**
  58  * @par Description: API to get value(char*) from vconf
  59  *
  60  *
  61  * @par Purpose:
  62  * @par Typical use case:
  63  * @par Method of function operation:
  64  * @par Important notes:
  65  * @param[in]           string type, key
  66  * @param[out]
  67  *
  68  * @return                              value on success
  69  *                                                      NULL on error
  70  *
  71  * @par Errors:
  72  *
  73  * @pre None.
  74  * @post
  75  * @see
  76  * @remarks None.
  77  *
  78  * @par Sample Code:
  79  * @code
  80  * @endcode
  81  */
  82 char *get_vconf_str_key(char *key);
  83
  84 /**
  85  * @par Description: API to get value(int) from vconf
  86  *
  87  *
  88  * @par Purpose:
  89  * @par Typical use case:
  90  * @par Method of function operation:
  91  * @par Important notes:
  92  * @param[in]           string type, base key
  93  * @param[in]           string type, key
  94  * @param[out]          int type, value
  95  *
  96  * @return                              true on success
  97  *                                                      false on error
  98  *
  99  * @par Errors:
 100  *
 101  * @pre None.
 102  * @post
 103  * @see
 104  * @remarks None.
 105  *
 106  * @par Sample Code:
 107  * @code
 108  * @endcode
 109  */
 110 bool get_vconf_int(char *base_key, char *key, int *value);
 111
 112 /**
 113  * @par Description: API to get value(int) from vconf
 114  *
 115  *
 116  * @par Purpose:
 117  * @par Typical use case:
 118  * @par Method of function operation:
 119  * @par Important notes:
 120  * @param[in]           string type, key
 121  * @param[out]          int type, value
 122  *
 123  * @return                              true on success
 124  *                                                      false on error
 125  *
 126  * @par Errors:
 127  *
 128  * @pre None.
 129  * @post
 130  * @see
 131  * @remarks None.
 132  *
 133  * @par Sample Code:
 134  * @code
 135  * @endcode
 136  */
 137 bool get_vconf_int_key(char *key, int *value);
 138
 139 /**
 140  * @par Description: API to set value(char*) into vconf
 141  *
 142  *
 143  * @par Purpose:
 144  * @par Typical use case:
 145  * @par Method of function operation:
 146  * @par Important notes:
 147  * @param[in]           string type, basekey
 148  * @param[in]           string type, key
 149  * @param[in]           string type, value
 150  *
 151  * @return                              true on success
 152  *                                                      false on error
 153  *
 154  * @par Errors:
 155  *
 156  * @pre None.
 157  * @post
 158  * @see
 159  * @remarks None.
 160  *
 161  * @par Sample Code:
 162  * @code
 163  * @endcode
 164  */
 165 bool set_vconf_str(char *base_key, char *key, char *value);
 166
 167 /**
 168  * @par Description: API to set value(char*) into vconf
 169  *
 170  *
 171  * @par Purpose:
 172  * @par Typical use case:
 173  * @par Method of function operation:
 174  * @par Important notes:
 175  * @param[in]           string type, key
 176  * @param[in]           string type, value
 177  *
 178  * @return                              true on success
 179  *                                                      false on error
 180  *
 181  * @par Errors:
 182  *
 183  * @pre None.
 184  * @post
 185  * @see
 186  * @remarks None.
 187  *
 188  * @par Sample Code:
 189  * @code
 190  * @endcode
 191  */
 192 bool set_vconf_str_key(char *key, char *value);
 193
 194 /**
 195  * @par Description: API to set value(int) into vconf
 196  *
 197  *
 198  * @par Purpose:
 199  * @par Typical use case:
 200  * @par Method of function operation:
 201  * @par Important notes:
 202  * @param[in]           string type, basekey
 203  * @param[in]           string type, key
 204  * @param[in]           int type, value
 205  *
 206  * @return                              true on success
 207  *                                                      false on error
 208  *
 209  * @par Errors:
 210  *
 211  * @pre None.
 212  * @post
 213  * @see
 214  * @remarks None.
 215  *
 216  * @par Sample Code:
 217  * @code
 218  * @endcode
 219  */
 220 bool set_vconf_int(char *base_key, char *key, int value);
 221
 222 /**
 223  * @par Description: API to set value(int) into vconf
 224  *
 225  *
 226  * @par Purpose:
 227  * @par Typical use case:
 228  * @par Method of function operation:
 229  * @par Important notes:
 230  * @param[in]           string type, key
 231  * @param[in]           int type, value
 232  *
 233  * @return                              true on success
 234  *                                                      false on error
 235  *
 236  * @par Errors:
 237  *
 238  * @pre None.
 239  * @post
 240  * @see
 241  * @remarks None.
 242  *
 243  * @par Sample Code:
 244  * @code
 245  * @endcode
 246  */
 247 bool set_vconf_int_key(char *key, int value);
 248
 249 #endif                          /* COMMON_VCONF_H_ */