Go to main content

man pages section 3: Library Interfaces and Headers

Exit Print View

Updated: Thursday, June 13, 2019
 
 

cfg_opt_t (3)

Name

cfg_opt_t - Data structure holding information about an option.

Synopsis

#include <confuse.h>

Data Fields
const char * name
The name of the option.
char * comment
Optional comment/annotation.
cfg_type_t type
Type of option.
unsigned int nvalues
Number of values parsed.
cfg_value_t ** values
Array of found values.
cfg_flag_t flags
Flags.
cfg_opt_t * subopts
Suboptions (only applies to sections)
cfg_defvalue_t def
Default value.
cfg_func_t func
Function callback for CFGT_FUNC options.
cfg_simple_t simple_value
Pointer to user-specified variable to store simple values (created
with the CFG_SIMPLE_* initializers)
cfg_callback_t parsecb
Value parsing callback function.
cfg_validate_callback_t validcb
Value validating parsing callback function.
cfg_validate_callback2_t validcb2
Value validating set callback function.
cfg_print_func_t pf
print callback function

Description

cfg_opt_t(3)                        confuse                       cfg_opt_t(3)



NAME
       cfg_opt_t - Data structure holding information about an option.


SYNOPSIS
       #include <confuse.h>

   Data Fields
       const char * name
           The name of the option.
       char * comment
           Optional comment/annotation.
       cfg_type_t type
           Type of option.
       unsigned int nvalues
           Number of values parsed.
       cfg_value_t ** values
           Array of found values.
       cfg_flag_t flags
           Flags.
       cfg_opt_t * subopts
           Suboptions (only applies to sections)
       cfg_defvalue_t def
           Default value.
       cfg_func_t func
           Function callback for CFGT_FUNC options.
       cfg_simple_t simple_value
           Pointer to user-specified variable to store simple values (created
           with the CFG_SIMPLE_* initializers)
       cfg_callback_t parsecb
           Value parsing callback function.
       cfg_validate_callback_t validcb
           Value validating parsing callback function.
       cfg_validate_callback2_t validcb2
           Value validating set callback function.
       cfg_print_func_t pf
           print callback function

Detailed Description
       Data structure holding information about an option.

       The value(s) are stored as an array of fundamental values (strings,
       numbers, etc).

       Examples:
           ftpconf.c, reread.c, and simple.c.


Author
       Generated automatically by Doxygen for confuse from the source code.



ATTRIBUTES
       See attributes(7) for descriptions of the following attributes:


       +---------------+--------------------+
       |ATTRIBUTE TYPE |  ATTRIBUTE VALUE   |
       +---------------+--------------------+
       |Availability   | library/libconfuse |
       +---------------+--------------------+
       |Stability      | Uncommitted        |
       +---------------+--------------------+
NOTES
       This software was built from source available at
       https://github.com/oracle/solaris-userland.  The original community
       source was downloaded from
       https://github.com/martinh/libconfuse/releases/download/v3.2/confuse-3.2.tar.gz

       Further information about this software can be found on the open source
       community website at https://github.com/martinh/libconfuse.



Version 3.2                     Sat Jun 3 2017                    cfg_opt_t(3)