[thirdparty/sarg.git] / documentation / getconf.txt

/*! \file getconf.c
\brief Configure sarg.
*/


/*! \fn static int is_param(const char *param,const char *buf)
Tell if the buffer contains a line defining the given parameter.

\param param The name of the parameter to find.
\param buf The string read from the input file.

\retval 1 Parameter match.
\retval 0 The line is not for that parameter.
*/


/*! \fn static int getparam_string(const char *param,char *buf,char *value,int value_size)
Extract a string value from a line if it is the right parameter.

\param param The name of the parameter to find.
\param buf The string read from the input file.
\param value The buffer to store the value.
\param value_size The size of the output buffer.

\retval 1 Parameter match.
\retval 0 The line is not for that parameter.
*/


/*! \fn static int getparam_quoted(const char *param,char *buf,char *value,int value_size)
Extract a quoted string value from a line if it is the right parameter.

\param param The name of the parameter to find.
\param buf The string read from the input file.
\param value The buffer to store the value.
\param value_size The size of the output buffer.

\retval 1 Parameter match.
\retval 0 The line is not for that parameter.
*/


/*! \fn static int getparam_int(const char *param,char *buf,int *value)
Extract an integer value from a line if it is the right parameter.

\param param The name of the parameter to find.
\param buf The string read from the input file.
\param value The variable to store the value.

\retval 1 Parameter match.
\retval 0 The line is not for that parameter.
*/


/*! \fn static int getparam_bool(const char *param,char *buf,int *value)
Extract a boolean flag from a line if it is the right parameter.

\param param The name of the parameter to find.
\param buf The string read from the input file.
\param value The variable to store the value.

\retval 1 Parameter match.
\retval 0 The line is not for that parameter.
*/


/*! \fn static void parmtest(char *buf)
Find what parameter is passed in the input buffer and store the value in memory.

\param buf One line of text from the configuration file.
*/


/*! \fn void getconf(void)
Read the configuration file whose name is in ::ConfigFile.
*/
Commit	Line	Data
4af2f8ff FM	1	/*! \file getconf.c
	2	\brief Configure sarg.
	3	*/
	4
	5
6e792ade	6	/! \fn static int is_param(const char param,const char *buf)
0a4e18e1 FM	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
4af2f8ff	19	/! \fn static int getparam_string(const char param,char buf,char value,int value_size)
e6414a9d	20	Extract a string value from a line if it is the right parameter.
4af2f8ff FM	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)
e6414a9d	36	Extract a quoted string value from a line if it is the right parameter.
4af2f8ff FM	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)
e6414a9d FM	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.
4af2f8ff FM	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