ArgsManager::ParseParameters

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

NameDescription
argcNumber of entries in argv.
argvArray of command-line argument strings.
errorPopulated with a message if parsing fails.