[#SettingToBool-0c]
= SettingToBool
:mrdocs:

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

== Synopsis

Declared in `<common/args.h>`

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

== Return Value

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]#