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

Read settings file.

== Synopsis

Declared in `<common/settings.h>`

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

== Return Value

true if the file was read successfully.

== Parameters

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


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