documentation/getconf.txt

   1 /*! \file getconf.c
   2 \brief Configure sarg.
   3 */
   4
   5
   6 /*! \fn static int is_param(const char *param,const char *buf)
   7 Tell if the buffer contains a line defining the given parameter.
   8
   9 \param param The name of the parameter to find.
  10 \param buf The string read from the input file.
  11
  12 \retval 1 Parameter match.
  13 \retval 0 The line is not for that parameter.
  14 */
  15
  16
  17
  18
  19 /*! \fn static int getparam_string(const char *param,char *buf,char *value,int value_size)
  20 Extract a string value from a line if it is the right parameter.
  21
  22 \param param The name of the parameter to find.
  23 \param buf The string read from the input file.
  24 \param value The buffer to store the value.
  25 \param value_size The size of the output buffer.
  26
  27 \retval 1 Parameter match.
  28 \retval 0 The line is not for that parameter.
  29 */
  30
  31
  32
  33
  34
  35 /*! \fn static int getparam_quoted(const char *param,char *buf,char *value,int value_size)
  36 Extract a quoted string value from a line if it is the right parameter.
  37
  38 \param param The name of the parameter to find.
  39 \param buf The string read from the input file.
  40 \param value The buffer to store the value.
  41 \param value_size The size of the output buffer.
  42
  43 \retval 1 Parameter match.
  44 \retval 0 The line is not for that parameter.
  45 */
  46
  47
  48
  49
  50
  51 /*! \fn static int getparam_int(const char *param,char *buf,int *value)
  52 Extract an integer value from a line if it is the right parameter.
  53
  54 \param param The name of the parameter to find.
  55 \param buf The string read from the input file.
  56 \param value The variable to store the value.
  57
  58 \retval 1 Parameter match.
  59 \retval 0 The line is not for that parameter.
  60 */
  61
  62
  63
  64
  65
  66 /*! \fn static int getparam_bool(const char *param,char *buf,int *value)
  67 Extract a boolean flag from a line if it is the right parameter.
  68
  69 \param param The name of the parameter to find.
  70 \param buf The string read from the input file.
  71 \param value The variable to store the value.
  72
  73 \retval 1 Parameter match.
  74 \retval 0 The line is not for that parameter.
  75 */
  76
  77
  78
  79
  80
  81 /*! \fn static void parmtest(char *buf)
  82 Find what parameter is passed in the input buffer and store the value in memory.
  83
  84 \param buf One line of text from the configuration file.
  85 */
  86
  87
  88
  89
  90
  91 /*! \fn void getconf(void)
  92 Read the configuration file whose name is in ::ConfigFile.
  93 */
  94