golcconfig 9.0
Loading...
Searching...
No Matches
Functions
LcConfigC_Get_C_API

various functions to get the configuration of the LcConfigCMore...

+ Collaboration diagram for LcConfigC_Get_C_API:

Functions

LC_EXTERN enum LcConfigFormatE LcConfigGetDefaultFormatP (LC_CFGN config)
 Non-inline replacement for LcConfigGetDefaultFormat
 
LC_EXTERN MK_SRT LcConfigGetFloatPrecisionP (LC_CFGN config)
 Non-inline replacement for LcConfigGetFloatPrecision
 
LC_EXTERN MK_STRN LcConfigGetIncludeDirP (LC_CFGN config)
 Non-inline replacement for LcConfigGetIncludeDir
 
LC_EXTERN MK_PTR LcConfigGetIncludeFuncP (LC_CFG const cfg)
 Non-inline replacement for LcConfigGetIncludeFunc
 
LC_EXTERN MK_BOOL LcConfigGetOptionP (LC_CFGN config, enum LcConfigOptionsEF option)
 Non-inline replacement for LcConfigGetOption
 
LC_EXTERN enum LcConfigOptionsEF LcConfigGetOptionsP (LC_CFGN config)
 Non-inline replacement for LcConfigGetOptions
 
LC_EXTERN MK_PTR LcConfigGetSettingDeleteFuncP (LC_CFG const cfg)
 Non-inline replacement for LcConfigGetSettingDeleteFunc
 
LC_EXTERN MK_SRT LcConfigGetTabWidthP (LC_CFGN config)
 Non-inline replacement for LcConfigGetTabWidth
 
enum LcConfigFormatE LcConfigGetDefaultFormat (LC_CFGN config)
 These functions, which are implemented as macros, get and set the default external format for settings in the configuration config
 
MK_SRT LcConfigGetFloatPrecision (LC_CFGN config)
 Since v1.6 These functions get and set the number of decimal digits to output after the radix character when writing the configuration to a file or stream …
 
MK_STRN LcConfigGetIncludeDir (LC_CFGN config)
 ConfigSetIncludeDir specifies the include directory, include_dir, relative to which the files specified in '@include' directives will be located for the configuration config
 
MK_BOOL LcConfigGetOption (LC_CFGN config, enum LcConfigOptionsEF option)
 Since v1.7 These functions get and set the given option of the configuration config
 
enum LcConfigOptionsEF LcConfigGetOptions (LC_CFGN config)
 These functions get and set the options for the configuration config
 
MK_SRT LcConfigGetTabWidth (LC_CFGN config)
 These functions, which are implemented as macros, get and set the tab width for the configuration config
 

Detailed Description

various functions to get the configuration of the LcConfigC

Function Documentation

◆ LcConfigGetDefaultFormat()

mk_inline enum LcConfigFormatE LcConfigGetDefaultFormat ( LC_CFGN  config)
inline

These functions, which are implemented as macros, get and set the default external format for settings in the configuration config

If a non-default format has not been set for a setting with config_setting_set_format, this configuration-wide default format will be used instead when that setting is written to a file or stream.

See also
ConfigSetDefaultFormat

Definition at line 405 of file LcConfigC_lc.h.

◆ LcConfigGetDefaultFormatP()

LC_EXTERN enum LcConfigFormatE LcConfigGetDefaultFormatP ( LC_CFGN  config)

Non-inline replacement for LcConfigGetDefaultFormat

◆ LcConfigGetFloatPrecision()

mk_inline MK_SRT LcConfigGetFloatPrecision ( LC_CFGN  config)
inline

Since v1.6 These functions get and set the number of decimal digits to output after the radix character when writing the configuration to a file or stream …

Valid values for digits range from 0 (no decimals) to about 15 (implementation defined). This parameter has no effect on parsing.

The default float precision is 6.

See also
ConfigSetFloatPrecision

Definition at line 410 of file LcConfigC_lc.h.

◆ LcConfigGetFloatPrecisionP()

LC_EXTERN MK_SRT LcConfigGetFloatPrecisionP ( LC_CFGN  config)

Non-inline replacement for LcConfigGetFloatPrecision

◆ LcConfigGetIncludeDir()

mk_inline MK_STRN LcConfigGetIncludeDir ( LC_CFGN  config)
inline

ConfigSetIncludeDir specifies the include directory, include_dir, relative to which the files specified in '@include' directives will be located for the configuration config

By default, there is no include directory, and all include files are expected to be relative to the current working directory. If include_dir is NULL, the default behavior is reinstated.

For example, if the include directory is set to /usr/local/etc, the include directive '@include "configs/extra.cfg"' would include the file /usr/local/etc/configs/extra.cfg.

ConfigGetIncludeDir returns the current include directory for the configuration config, or NULL if none is set.

See also
ConfigSetIncludeDir

Definition at line 415 of file LcConfigC_lc.h.

◆ LcConfigGetIncludeDirP()

LC_EXTERN MK_STRN LcConfigGetIncludeDirP ( LC_CFGN  config)

Non-inline replacement for LcConfigGetIncludeDir

◆ LcConfigGetIncludeFuncP()

LC_EXTERN MK_PTR LcConfigGetIncludeFuncP ( LC_CFG const  cfg)

Non-inline replacement for LcConfigGetIncludeFunc

◆ LcConfigGetOption()

mk_inline MK_BOOL LcConfigGetOption ( LC_CFGN  config,
enum LcConfigOptionsEF  option 
)
inline

Since v1.7 These functions get and set the given option of the configuration config

The option is enabled if flag is CONFIG_TRUE and disabled if it is CONFIG_FALSE.

See ConfigSetOptions above for the list of available options.

See also
ConfigSetOption

Definition at line 421 of file LcConfigC_lc.h.

◆ LcConfigGetOptionP()

LC_EXTERN MK_BOOL LcConfigGetOptionP ( LC_CFGN  config,
enum LcConfigOptionsEF  option 
)

Non-inline replacement for LcConfigGetOption

◆ LcConfigGetOptions()

mk_inline enum LcConfigOptionsEF LcConfigGetOptions ( LC_CFGN  config)
inline

These functions get and set the options for the configuration config

The options affect how configurations are read and written. The following options are defined:

CONFIG_OPTION_AUTOCONVERT

Turning this option on enables number auto-conversion for the configuration. When this feature is enabled, an attempt to retrieve a floating point setting's value into an integer (or vice versa), or store an integer to a floating point setting's value (or vice versa) will cause the library to silently perform the necessary conversion (possibly leading to loss of data), rather than reporting failure. By default this option is turned off.

CONFIG_OPTION_SEMICOLON_SEPARATORS

This option controls whether a semicolon (';') is output after each setting when the configuration is written to a file or stream. (The semicolon separators are optional in the configuration syntax.) By default this option is turned on.

CONFIG_OPTION_COLON_ASSIGNMENT_FOR_GROUPS

This option controls whether a colon (':') is output between each group setting's name and its value when the configuration is written to a file or stream. If the option is turned off, an equals sign ('=') is output instead. (These tokens are interchangeable in the configuration syntax.) By default this option is turned on.

CONFIG_OPTION_COLON_ASSIGNMENT_FOR_NON_GROUPS

This option controls whether a colon (':') is output between each non-group setting's name and its value when the configuration is written to a file or stream. If the option is turned off, an equals sign ('=') is output instead. (These tokens are interchangeable in the configuration syntax.) By default this option is turned off.

CONFIG_OPTION_OPEN_BRACE_ON_SEPARATE_LINE

This option controls whether an open brace ('{') will be written on its own line when the configuration is written to a file or stream. If the option is turned off, the brace will be written at the end of the previous line. By default this option is turned on.

CONFIG_OPTION_ALLOW_SCIENTIFIC_NOTATION

(Since v1.7) This option controls whether scientific notation may be used as appropriate when writing floating point values (corresponding to printf 'g' format) or should never be used (corresponding to printf 'f' format). By default this option is turned off.

CONFIG_OPTION_FSYNC

(Since v1.7.1) This option controls whether the ConfigWriteFile function performs an fsync operation after writing the configuration and before closing the file. By default this option is turned off.

CONFIG_OPTION_ALLOW_OVERRIDES

(Since v1.7.3) This option controls whether duplicate settings override previous settings with the same name. If this option is turned off, duplicate settings are rejected. By default this option is turned off.

See also
ConfigSetOptions

Definition at line 426 of file LcConfigC_lc.h.

◆ LcConfigGetOptionsP()

LC_EXTERN enum LcConfigOptionsEF LcConfigGetOptionsP ( LC_CFGN  config)

Non-inline replacement for LcConfigGetOptions

◆ LcConfigGetSettingDeleteFuncP()

LC_EXTERN MK_PTR LcConfigGetSettingDeleteFuncP ( LC_CFG const  cfg)

Non-inline replacement for LcConfigGetSettingDeleteFunc

◆ LcConfigGetTabWidth()

mk_inline MK_SRT LcConfigGetTabWidth ( LC_CFGN  config)
inline

These functions, which are implemented as macros, get and set the tab width for the configuration config

The tab width affects the formatting of the configuration when it is written to a file or stream: each level of nesting is indented by width spaces, or by a single tab character if width is 0. The tab width has no effect on parsing.

Valid tab widths range from 0 to 15. The default tab width is 2.

See also
ConfigSetTabWidth

Definition at line 431 of file LcConfigC_lc.h.

◆ LcConfigGetTabWidthP()

LC_EXTERN MK_SRT LcConfigGetTabWidthP ( LC_CFGN  config)

Non-inline replacement for LcConfigGetTabWidth