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

Parse command‐line parameters into settings.

== Synopsis

Declared in `<common/args.h>`

[source,cpp,subs="verbatim,replacements,macros,-callouts"]
----
[[nodiscard, requires_capability(0x7f2e381abfc8)]]
bool
ParseParameters(
    int argc,
    char const const* argv[],
    std::string& error);
----

== Return Value

true if the parameters were parsed successfully.

[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.
| *argv*
| Array of command‐line argument strings.
| *error*
| Populated with a message if parsing fails.
|===


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