Parse command‐line parameters into settings.

Synopsis

Declared in <common/args.h>

[[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 should not be discarded.

Parameters

Name

Description

argc

Number of entries in argv.

argv

Array of command‐line argument strings.

error

Populated with a message if parsing fails.

Created with MrDocs