[#InterpretValue]
= InterpretValue
:mrdocs:

Interpret a raw configuration value according to a key and its flags.

== Synopsis

Declared in `<common/args.h>`

[source,cpp,subs="verbatim,replacements,macros,-callouts"]
----
std::optional<common::SettingsValue>
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::nullopt on error.

== Parameters

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


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