Skip to content

CommandlineProcessing::isOptionWithParameter

isOptionWithParameter overloads

Synopses

Declared in <commandlineProcessing/commandline_processing.h>

Search 'argv' for 'optionPrefixOption value' (string).

[[visibility]]
bool
isOptionWithParameter(
    std::vector<std::string>& argv,
    std::string optionPrefix,
    std::string Option,
    std::string& optionParameter,
    bool removeOption);

Search 'argv' for 'optionPrefixOption value' (int).

[[visibility]]
bool
isOptionWithParameter(
    std::vector<std::string>& argv,
    std::string optionPrefix,
    std::string Option,
    int& optionParameter,
    bool removeOption);

Search 'argv' for 'optionPrefixOption value' (float).

[[visibility]]
bool
isOptionWithParameter(
    std::vector<std::string>& argv,
    std::string optionPrefix,
    std::string Option,
    float& optionParameter,
    bool removeOption);

Return Value

True if the option was found.

Parameters

Name

Description

argv

Argument vector to search.

optionPrefix

Prefix for the option.

Option

Option name or regex.

optionParameter

Receives the parsed value.

removeOption

Whether to remove the option from argv.

Created with MrDocs