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

Write settings file or backup 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(0x7f2e381af028)]]
bool
WriteSettingsFile(
    std::vector<std::string>* errors = nullptr,
    bool backup = false) const;
----

== Return Value

true if the settings file was written successfully.

== Parameters

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


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