[#BloombergLP-balcl-CommandLine-parse-00]
= xref:BloombergLP.adoc[BloombergLP]::xref:BloombergLP/balcl.adoc[balcl]::xref:BloombergLP/balcl/CommandLine.adoc[CommandLine]::parse
:relfileprefix: ../../../
:mrdocs:

Parse the command‐line arguments in `argv` of length `argc`.

== Synopsis

Declared in `<balcl_commandline.h>`

[source,cpp,subs="verbatim,replacements,macros,-callouts"]
----
int
parse(
    int argc,
    char const const* argv[],
    std::ostream& errorStream);
----

== Description

Write any error message to the specified `errorStream`. Return 0 on success, and a non‐zero value otherwise.

== Return Value

0 on success, and a non‐zero value otherwise

== Parameters

[cols="1,4"]
|===
| Name| Description
| *argc*
| length of the `argv` array
| *argv*
| array of command‐line argument strings
| *errorStream*
| stream to which parse errors are written
|===


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