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

Parse command&hyphen;line parameters into settings&period;

== Synopsis

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

[source,cpp,subs="verbatim,replacements,macros,-callouts"]
----
&lsqb;&lsqb;nodiscard, requires&lowbar;capability(0x7f9524a21368)&rsqb;&rsqb;
bool
ParseParameters(
    int argc,
    char const const* argv[],
    std::string& error);
----

== Return Value

true if the parameters were parsed successfully&period;

[NOTE]
====
The return value https://en.cppreference.com/cpp/language/attributes/nodiscard[should not be discarded^].
====
== Parameters

[cols="1,4"]
|===
| Name| Description
| *argc*
| Number of entries in argv&period;
| *argv*
| Array of command&hyphen;line argument strings&period;
| *error*
| Populated with a message if parsing fails&period;
|===


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