src/liboconfig/utils.h

   1 /**
   2  * SysDB - src/liboconfig/utils.h
   3  * Copyright (C) 2012 Sebastian 'tokkee' Harl <sh@tokkee.org>
   4  *
   5  * Permission is hereby granted, free of charge, to any person obtaining a
   6  * copy of this software and associated documentation files (the "Software"),
   7  * to deal in the Software without restriction, including without limitation
   8  * the rights to use, copy, modify, merge, publish, distribute, sublicense,
   9  * and/or sell copies of the Software, and to permit persons to whom the
  10  * Software is furnished to do so, subject to the following conditions:
  11  *
  12  * The above copyright notice and this permission notice shall be included in
  13  * all copies or substantial portions of the Software.
  14  *
  15  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
  16  * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
  17  * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
  18  * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
  19  * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
  20  * FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
  21  * DEALINGS IN THE SOFTWARE.
  22  */
  23
  24 #ifndef SDB_OCONFIG_UTILS_H
  25 #define SDB_OCONFIG_UTILS_H 1
  26
  27 #include "oconfig.h"
  28
  29 #include <stdbool.h>
  30
  31 #ifdef __cplusplus
  32 extern "C" {
  33 #endif
  34
  35 /* oconfig_get_<type>:
  36  * Checks if the specified item has exactly one value of the respective type
  37  * and returns that value through the appropriate parameter.
  38  *
  39  * Returns:
  40  *  - 0 on success
  41  *  - a negative value else
  42  */
  43 int
  44 oconfig_get_string(oconfig_item_t *ci, char **value);
  45 int
  46 oconfig_get_number(oconfig_item_t *ci, double *value);
  47 int
  48 oconfig_get_boolean(oconfig_item_t *ci, bool *value);
  49
  50 #ifdef __cplusplus
  51 } /* extern "C" */
  52 #endif
  53
  54 #endif /* SDB_OCONFIG_UTILS_H */
  55
  56 /* vim: set tw=78 sw=4 ts=4 noexpandtab : */
  57