Boost C++ Libraries Home Libraries People FAQ More

PrevUpHomeNext

Class untyped_value

boost::program_options::untyped_value

Synopsis

// In header: <boost/program_options/value_semantic.hpp>


class untyped_value : public  {
public:
  // construct/copy/destruct
  ( = );

  // public member functions
   () ;
   () ;
   () ;
   () ;
   () ;
   (, ) ;
   () ;
   () ;
};

Description

Class which specifies a simple handling of a value: the value will have string type and only one token is allowed.

untyped_value public construct/copy/destruct

  1. ( zero_tokens = );

untyped_value public member functions

  1.  () ;

    Returns the name of the option. The name is only meaningful for automatic help message.

  2.  () ;

    The minimum number of tokens for this option that should be present on the command line.

  3.  () ;

    The maximum number of tokens for this option that should be present on the command line.

  4.  () ;

    Returns true if values from different sources should be composed. Otherwise, value from the first source is used and values from other sources are discarded.

  5.  () ;

    Returns true if value must be given. Non-optional value

  6.  
    ( value_store, 
            new_tokens) ;

    If 'value_store' is already initialized, or new_tokens has more than one elements, throws. Otherwise, assigns the first string from 'new_tokens' to 'value_store', without any modifications.

  7.  () ;

    Does nothing.

  8.  () ;

    Does nothing.


PrevUpHomeNext