[#InterpretValue]
= InterpretValue
:mrdocs:

Interpret a raw configuration value according to a key and its flags&period;

== Synopsis

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

[source,cpp,subs="verbatim,replacements,macros,-callouts"]
----
std::optional&lt;common::SettingsValue&gt;
InterpretValue(
    xref:KeyInfo.adoc[KeyInfo] const& key,
    std::string const* value,
    unsigned int flags,
    std::string& error);
----

== Return Value

The interpreted setting value, or std&colon;&colon;nullopt on error&period;

== Parameters

[cols="1,4"]
|===
| Name| Description
| *key*
| The parsed key the value belongs to&period;
| *value*
| The raw value string, or nullptr if no value was given&period;
| *flags*
| Argument flags controlling validation and interpretation&period;
| *error*
| Populated with a message if interpretation fails&period;
|===


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