[#common-ReadSettings]
= xref:common.adoc[common]::ReadSettings
:relfileprefix: ../
:mrdocs:

Read settings file&period;

== Synopsis

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

[source,cpp,subs="verbatim,replacements,macros,-callouts"]
----
bool
ReadSettings(
    xref:fs/path.adoc[fs::path] const& path,
    std::map&lt;std::string, SettingsValue&gt;& values,
    std::vector&lt;std::string&gt;& errors);
----

== Return Value

true if the file was read successfully&period;

== Parameters

[cols="1,4"]
|===
| Name| Description
| *path*
| Path to the settings file&period;
| *values*
| Populated with the settings read from the file&period;
| *errors*
| Populated with any parse errors encountered&period;
|===


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