Annotation of embedaddon/confuse/doc/man/man3/cfg_opt_t.3, revision 1.1.1.1
1.1 misho 1: .TH "cfg_opt_t" 3 "21 Feb 2010" "Version 2.7" "confuse" \" -*- nroff -*-
2: .ad l
3: .nh
4: .SH NAME
5: cfg_opt_t \- Data structure holding information about an option.
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 "char * \fBname\fP"
18: .br
19: .RI "\fIThe name of the option. \fP"
20: .ti -1c
21: .RI "\fBcfg_type_t\fP \fBtype\fP"
22: .br
23: .RI "\fIType of option. \fP"
24: .ti -1c
25: .RI "unsigned int \fBnvalues\fP"
26: .br
27: .RI "\fINumber of values parsed. \fP"
28: .ti -1c
29: .RI "\fBcfg_value_t\fP ** \fBvalues\fP"
30: .br
31: .RI "\fIArray of found values. \fP"
32: .ti -1c
33: .RI "cfg_flag_t \fBflags\fP"
34: .br
35: .RI "\fIFlags. \fP"
36: .ti -1c
37: .RI "\fBcfg_opt_t\fP * \fBsubopts\fP"
38: .br
39: .RI "\fISuboptions (only applies to sections). \fP"
40: .ti -1c
41: .RI "\fBcfg_defvalue_t\fP \fBdef\fP"
42: .br
43: .RI "\fIDefault value. \fP"
44: .ti -1c
45: .RI "\fBcfg_func_t\fP \fBfunc\fP"
46: .br
47: .RI "\fIFunction callback for CFGT_FUNC options. \fP"
48: .ti -1c
49: .RI "void * \fBsimple_value\fP"
50: .br
51: .RI "\fIPointer to user-specified variable to store simple values (created with the CFG_SIMPLE_* initializers). \fP"
52: .ti -1c
53: .RI "\fBcfg_callback_t\fP \fBparsecb\fP"
54: .br
55: .RI "\fIValue parsing callback function. \fP"
56: .ti -1c
57: .RI "\fBcfg_validate_callback_t\fP \fBvalidcb\fP"
58: .br
59: .RI "\fIValue validating callback function. \fP"
60: .ti -1c
61: .RI "\fBcfg_print_func_t\fP \fBpf\fP"
62: .br
63: .RI "\fIprint callback function \fP"
64: .in -1c
65: .SH "Detailed Description"
66: .PP
67: Data structure holding information about an option.
68:
69: The value(s) are stored as an array of fundamental values (strings, numbers, etc).
70: .PP
71: \fBExamples: \fP
72: .in +1c
73: .PP
74: \fBftpconf.c\fP, \fBreread.c\fP, and \fBsimple.c\fP.
75:
76: .SH "Author"
77: .PP
78: Generated automatically by Doxygen for confuse from the source code.
FreeBSD-CVSweb <freebsd-cvsweb@FreeBSD.org>