[#SettingToBool-05]
= SettingToBool
:mrdocs:

`SettingToBool` overloads

== Synopses

Declared in `&lt;common&sol;args&period;h&gt;`

Convert a settings value to an optional boolean&period;


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

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

Convert a settings value to a boolean, using a default when unset&period;


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

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

== Return Value

* The boolean value, or std&colon;&colon;nullopt when unset&period;
* The boolean value, or the provided default when unset&period;

== Parameters

[cols="1,4"]
|===
| Name| Description
| *value*
| The settings value to convert&period;
| *default&lowbar;value*
| Value returned when the setting is unset&period;
|===


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