Boost C++ Libraries

...one of the most highly regarded and expertly designed C++ library projects in the world. Herb Sutter and Andrei Alexandrescu, C++ Coding Standards

Click here to view the latest version of this page.
PrevUpHomeNext

Reference

Header <boost/program_options/cmdline.hpp>
Header <boost/program_options/environment_iterator.hpp>
Header <boost/program_options/eof_iterator.hpp>
Header <boost/program_options/errors.hpp>
Header <boost/program_options/option.hpp>
Header <boost/program_options/options_description.hpp>
Header <boost/program_options/parsers.hpp>
Header <boost/program_options/positional_options.hpp>
Header <boost/program_options/value_semantic.hpp>
Header <boost/program_options/variables_map.hpp>
Header <boost/program_options/version.hpp>
namespace boost {
  namespace program_options {
    namespace command_line_style {
      enum style_t;
    }
  }
}
namespace boost {
  class environment_iterator;
}
namespace boost {
  template<typename Derived, typename ValueType> class eof_iterator;
}
namespace boost {
  namespace program_options {
    class error;
    class invalid_syntax;
    class unknown_option;
    class ambiguous_option;
    class multiple_values;
    class multiple_occurrences;
    class validation_error;
    class invalid_option_value;
    class too_many_positional_options_error;
    class too_few_positional_options_error;
    class invalid_command_line_syntax;
    class invalid_command_line_style;
  }
}
namespace boost {
  namespace program_options {
    template<typename charT> class basic_option;

    typedef basic_option< char > option;
    typedef basic_option< wchar_t > woption;
  }
}
namespace boost {
  namespace program_options {
    class option_description;
    class options_description_easy_init;
    class options_description;
    class duplicate_option_error;
  }
}
namespace boost {
  namespace program_options {
    template<typename charT> class basic_parsed_options;

    template<> class basic_parsed_options<wchar_t>;

    template<typename charT> class basic_command_line_parser;

    enum collect_unrecognized_mode;

    typedef basic_parsed_options< char > parsed_options;
    typedef basic_parsed_options< wchar_t > wparsed_options;
    typedef function1< std::pair< std::string, std::string >, const std::string & > ext_parser;
    typedef basic_command_line_parser< char > command_line_parser;
    typedef basic_command_line_parser< wchar_t > wcommand_line_parser;
    template<typename charT> 
      basic_parsed_options< charT > 
      parse_command_line(int, charT *, const options_description &, int = 0, 
                         function1< std::pair< std::string, std::string >, const std::string & > = ext_parser());
    template<typename charT> 
      BOOST_PROGRAM_OPTIONS_DECL basic_parsed_options< charT > 
      parse_config_file(std::basic_istream< charT > &, 
                        const options_description &, bool = false);
    template<typename charT> 
      std::vector< std::basic_string< charT > > 
      collect_unrecognized(const std::vector< basic_option< charT > > &, 
                           enum collect_unrecognized_mode);
    BOOST_PROGRAM_OPTIONS_DECL parsed_options 
    parse_environment(const options_description &, 
                      const function1< std::string, std::string > &);
    BOOST_PROGRAM_OPTIONS_DECL parsed_options 
    parse_environment(const options_description &, const std::string &);
    BOOST_PROGRAM_OPTIONS_DECL parsed_options 
    parse_environment(const options_description &, const char *);
  }
}
namespace boost {
  namespace program_options {
    class positional_options_description;
  }
}
namespace boost {
  namespace program_options {
    class value_semantic;
    template<typename charT> class value_semantic_codecvt_helper;

    template<> class value_semantic_codecvt_helper<char>;
    template<> class value_semantic_codecvt_helper<wchar_t>;

    class untyped_value;
    class typed_value_base;
    template<typename T, typename charT = char> class typed_value;
    template<typename T> typed_value< T > * value();
    template<typename T> typed_value< T > * value(T *);
    template<typename T> typed_value< T, wchar_t > * wvalue();
    template<typename T> typed_value< T, wchar_t > * wvalue(T *);
    BOOST_PROGRAM_OPTIONS_DECL typed_value< bool > * bool_switch();
    BOOST_PROGRAM_OPTIONS_DECL typed_value< bool > * bool_switch(bool *);
  }
}
namespace boost {
  namespace program_options {
    class variable_value;
    class abstract_variables_map;
    class variables_map;
    BOOST_PROGRAM_OPTIONS_DECL void 
    store(const basic_parsed_options< char > &, variables_map &, bool = false);
    BOOST_PROGRAM_OPTIONS_DECL void 
    store(const basic_parsed_options< wchar_t > &, variables_map &);
    BOOST_PROGRAM_OPTIONS_DECL void notify(variables_map &);
  }
}

BOOST_PROGRAM_OPTIONS_VERSION

PrevUpHomeNext