Skip to content

ArgFlag

Description

Register a boolean toggle. No value consumed; presence sets the target to true. Target must be bool *.

Usage example (from documentation)

  bool verbose = false;
  ArgFlag(&p, "-v", "--verbose", &verbose, "verbose logging");

Usage example (Cross-references)

Usage examples (Cross-references)
    
        bool verbose = false;
        ArgFlag(&p, "-v", "--verbose", &verbose, "verbose");
    
        char  *argv[] = {(char *)"prog", (char *)"--verbose"};
    
        bool verbose = false;
        ArgFlag(&p, "-v", "--verbose", &verbose, "verbose");
    
        char  *argv[] = {(char *)"prog"};
        ArgPositional(&p, "source", &src, "from");
        ArgPositional(&p, "dest", &dst, "to");
        ArgFlag(&p, "-v", "--verbose", &verbose, "v");
    
        char  *argv[] = {(char *)"cp", (char *)"a.txt", (char *)"-v", (char *)"b.txt"};
    
        bool v = false;
        ArgFlag(&p, "-v", "--verbose", &v, "");
    
        char  *argv[] = {(char *)"prog", (char *)"--bogus"};
        }
        if (role == ARG_ROLE_FLAG && target.kind != ARG_KIND_BOOL) {
            LOG_FATAL("arg_register: ArgFlag '{}' requires a bool* target", long_name ? long_name : short_name);
        }
        if (role == ARG_ROLE_COUNT && target.kind != ARG_KIND_U8 && target.kind != ARG_KIND_U16 &&
Last updated on