Annotation of embedaddon/confuse/doc/man/man3/cfg_t.3, revision 1.1.1.1
1.1 misho 1: .TH "cfg_t" 3 "21 Feb 2010" "Version 2.7" "confuse" \" -*- nroff -*-
2: .ad l
3: .nh
4: .SH NAME
5: cfg_t \- Data structure holding information about a 'section'.
6:
7: .PP
8: .SH SYNOPSIS
9: .br
10: .PP
11: \fC#include <confuse.h>\fP
12: .PP
13: .SS "Data Fields"
14:
15: .in +1c
16: .ti -1c
17: .RI "cfg_flag_t \fBflags\fP"
18: .br
19: .RI "\fIAny flags passed to \fBcfg_init()\fP. \fP"
20: .ti -1c
21: .RI "char * \fBname\fP"
22: .br
23: .RI "\fIThe name of this section, the root section returned from \fBcfg_init()\fP is always named 'root'. \fP"
24: .ti -1c
25: .RI "\fBcfg_opt_t\fP * \fBopts\fP"
26: .br
27: .RI "\fIArray of options. \fP"
28: .ti -1c
29: .RI "char * \fBtitle\fP"
30: .br
31: .RI "\fIOptional title for this section, only set if CFGF_TITLE flag is set. \fP"
32: .ti -1c
33: .RI "char * \fBfilename\fP"
34: .br
35: .RI "\fIName of the file being parsed. \fP"
36: .ti -1c
37: .RI "int \fBline\fP"
38: .br
39: .RI "\fILine number in the config file. \fP"
40: .ti -1c
41: .RI "\fBcfg_errfunc_t\fP \fBerrfunc\fP"
42: .br
43: .RI "\fIThis function (if set with cfg_set_error_function) is called for any error message. \fP"
44: .in -1c
45: .SH "Detailed Description"
46: .PP
47: Data structure holding information about a 'section'.
48:
49: Sections can be nested. A section has a list of options (strings, numbers, booleans or other sections) grouped together.
50: .PP
51: \fBExamples: \fP
52: .in +1c
53: .PP
54: \fBftpconf.c\fP, \fBreread.c\fP, and \fBsimple.c\fP.
55: .SH "Field Documentation"
56: .PP
57: .SS "\fBcfg_errfunc_t\fP \fBcfg_t::errfunc\fP"
58: .PP
59: This function (if set with cfg_set_error_function) is called for any error message.
60: .PP
61:
62: .PP
63: Referenced by cfg_error(), cfg_init(), cfg_set_error_function(), and cfg_setopt().
64:
65: .SH "Author"
66: .PP
67: Generated automatically by Doxygen for confuse from the source code.
FreeBSD-CVSweb <freebsd-cvsweb@FreeBSD.org>