[#common-Settings]
= xref:common.adoc[common]::Settings
:relfileprefix: ../
:mrdocs:

Stored settings. This struct combines settings from the command line, a read‐only configuration file, and a read‐write runtime settings file.

== Synopsis

Declared in `<common/settings.h>`

[source,cpp,subs="verbatim,replacements,macros,-callouts"]
----
struct Settings;
----

== Data Members

[cols="1,4"]
|===
| Name| Description
| xref:common/Settings/command_line_options.adoc[`command_line_options`] 
| Map of setting name to list of command line values.
| xref:common/Settings/forced_settings.adoc[`forced_settings`] 
| Map of setting name to forced setting value.
| xref:common/Settings/ro_config.adoc[`ro_config`] 
| Map of config section name and setting name to list of config file values.
| xref:common/Settings/rw_settings.adoc[`rw_settings`] 
| Map of setting name to read‐write file setting value.
|===


== Non-Member Functions

[cols="1,4"]
|===
| Name| Description
| xref:common/GetSetting.adoc[`GetSetting`]
| Get settings value from combined sources: forced settings, command line arguments, runtime read‐write settings, and the read‐only config file.
| xref:common/GetSettingsList.adoc[`GetSettingsList`]
| Get combined setting value similar to GetSetting(), except if setting was specified multiple times, return a list of all the values specified.
| xref:common/OnlyHasDefaultSectionSetting.adoc[`OnlyHasDefaultSectionSetting`]
| Return true if a setting is set in the default config file section, and not overridden by a higher priority command‐line or network section value.
|===


[.small]#Created with https://www.mrdocs.com[MrDocs]#