[#SettingToBool-05]
= SettingToBool
:mrdocs:

`SettingToBool` overloads

== Synopses

Declared in `<common/args.h>`

Convert a settings value to an optional boolean.


[source,cpp,subs="verbatim,replacements,macros,-callouts"]
----
std::optional<bool>
xref:SettingToBool-09.adoc[SettingToBool](xref:common/SettingsValue.adoc[common::SettingsValue] const& value);
----

[.small]#xref:SettingToBool-09.adoc[_» more..._]#

Convert a settings value to a boolean, using a default when unset.


[source,cpp,subs="verbatim,replacements,macros,-callouts"]
----
bool
xref:SettingToBool-0c.adoc[SettingToBool](
    xref:common/SettingsValue.adoc[common::SettingsValue] const& value,
    bool default_value);
----

[.small]#xref:SettingToBool-0c.adoc[_» more..._]#

== Return Value

* The boolean value, or std::nullopt when unset.
* The boolean value, or the provided default when unset.

== Parameters

[cols="1,4"]
|===
| Name| Description
| *value*
| The settings value to convert.
| *default_value*
| Value returned when the setting is unset.
|===


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