Go to main content

man pages section 3: Library Interfaces and Headers

Exit Print View

Updated: Thursday, June 13, 2019
 
 

cfg_t (3)

Name

cfg_t - Data structure holding information about a 'section'.

Synopsis

#include <confuse.h>

Data Fields
cfg_flag_t flags
Any flags passed to cfg_init()
char * name
The name of this section, the root section returned from cfg_init()
is always named 'root'.
char * comment
Optional annotation/comment.
cfg_opt_t * opts
Array of options.
char * title
Optional title for this section, only set if CFGF_TITLE flag is
set.
char * filename
Name of the file being parsed.
int line
Line number in the config file.
cfg_errfunc_t errfunc
This function (if set with cfg_set_error_function) is called for
any error message.
cfg_searchpath_t * path
Linked list of directories to search.

Description

cfg_t(3)                            confuse                           cfg_t(3)



NAME
       cfg_t - Data structure holding information about a 'section'.


SYNOPSIS
       #include <confuse.h>

   Data Fields
       cfg_flag_t flags
           Any flags passed to cfg_init()
       char * name
           The name of this section, the root section returned from cfg_init()
           is always named 'root'.
       char * comment
           Optional annotation/comment.
       cfg_opt_t * opts
           Array of options.
       char * title
           Optional title for this section, only set if CFGF_TITLE flag is
           set.
       char * filename
           Name of the file being parsed.
       int line
           Line number in the config file.
       cfg_errfunc_t errfunc
           This function (if set with cfg_set_error_function) is called for
           any error message.
       cfg_searchpath_t * path
           Linked list of directories to search.

Detailed Description
       Data structure holding information about a 'section'.

       Sections can be nested. A section has a list of options (strings,
       numbers, booleans or other sections) grouped together.

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

Field Documentation
   cfg_errfunc_t cfg_t::errfunc
       This function (if set with cfg_set_error_function) is called for any
       error message.

       Referenced by cfg_addtsec(), cfg_error(), cfg_init(),
       cfg_set_error_function(), and cfg_setopt().


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_t(3)