[#ArgsManager-ReadSettingsFile]
= xref:ArgsManager.adoc[ArgsManager]::ReadSettingsFile
:relfileprefix: ../
:mrdocs:

Read settings file. Push errors to vector, or log them if null.

== Synopsis

Declared in `<common/args.h>`

[source,cpp,subs="verbatim,replacements,macros,-callouts"]
----
[[requires_capability(0x7f2e381aeee8)]]
bool
ReadSettingsFile(std::vector<std::string>* errors = nullptr);
----

== Return Value

true if the settings file was read successfully.

== Parameters

[cols="1,4"]
|===
| Name| Description
| *errors*
| If non‐null, populated with any read errors.
|===


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