Class template basic_command_line_parserboost::program_options::basic_command_line_parser Synopsistemplate<typename charT> class basic_command_line_parser { public: // construct/copy/destruct basic_command_line_parser(const std::vector< std::basic_string< charT > > &); basic_command_line_parser(int, charT *); // public member functions basic_command_line_parser & options(const options_description &) ; basic_command_line_parser & positional(const positional_options_description &) ; basic_command_line_parser & style(int) ; basic_command_line_parser & extra_parser(ext_parser) ; basic_parsed_options< charT > run() ; basic_command_line_parser & allow_unregistered() ; basic_command_line_parser & extra_style_parser(style_parser) ; }; DescriptionCommand line parser. The class allows one to specify all the information needed for parsing and to parse the command line. It is primarily needed to emulate named function parameters -- a regular function with 5 parameters will be hard to use and creating overloads with a smaller nuber of parameters will be confusing. For the most common case, the function parse_command_line is a better alternative. There are two typedefs -- command_line_parser and wcommand_line_parser, for charT == char and charT == wchar_t cases.
|