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

Write settings file or backup settings file&period; Push errors to vector, or log them if null&period;

== Synopsis

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

[source,cpp,subs="verbatim,replacements,macros,-callouts"]
----
&lsqb;&lsqb;requires&lowbar;capability(0x7f9524a243c8)&rsqb;&rsqb;
bool
WriteSettingsFile(
    std::vector&lt;std::string&gt;* errors = nullptr,
    bool backup = false) const;
----

== Return Value

true if the settings file was written successfully&period;

== Parameters

[cols="1,4"]
|===
| Name| Description
| *errors*
| If non&hyphen;null, populated with any write errors&period;
| *backup*
| Write the backup settings file instead of the main one&period;
|===


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