[#SettingToString-00]
= SettingToString
:mrdocs:

`SettingToString` overloads

== Synopses

Declared in `<common/args.h>`

Convert a settings value to an optional string.


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

[.small]#xref:SettingToString-05.adoc[_» more..._]#

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


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

[.small]#xref:SettingToString-0b.adoc[_» more..._]#

== Return Value

* The string value, or std::nullopt when unset.
* The string 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]#