Boost C++ Libraries Home Libraries People FAQ More

PrevUpHomeNext

Class template basic_environment

boost::process::basic_environment — Type definition to hold a seperate environment.

Synopsis

// In header: <boost/process/environment.hpp>

template<typename Char> 
class basic_environment {
public:
  // types
  typedef                                ;   
  typedef        ;      
  typedef  ;
  typedef                                              ;     
  typedef                                              ; 
  typedef                                              ;     

  // member classes/structs/unions
  template<typename Char, typename Environment> 
  struct const_entry_type {
    // types
    typedef                              ;   
    typedef                ;      
    typedef   ;  
    typedef  ;        
    typedef                       ;

    // construct/copy/destruct
     () = ;

    // public member functions
     () ;
     () = ;
     () ;
  };
  template<typename Char, typename Environment> 
  struct entry_type {
    // types
    typedef                              ;   
    typedef                ;      
    typedef   ;  
    typedef  ;        
    typedef                       ;

    // construct/copy/destruct
     () = ;
     ();
     ();

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

  // construct/copy/destruct
  ();
  (basic_environment &);
  (basic_environment &&);
  basic_environment & (basic_environment &);
  basic_environment & (basic_environment &&);

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

Description

Template representation of environments. It takes a character type (char or wchar_t) as template parameter to implement the environment

basic_environment public construct/copy/destruct

  1. ();
    Default constructor.
  2. (basic_environment &);
    Copy constructor.
  3. (basic_environment &&);
    Move constructor.
  4. basic_environment & (basic_environment &);
    Copy assignment.
  5. basic_environment & (basic_environment &&);
    Move assignment.

basic_environment public member functions

  1.  ();
    Returns an iterator to the beginning.
  2.  () ;
    Returns an iterator to the beginning.
  3.  () ;
    Returns an iterator to the beginning.
  4.  ();
    Returns an iterator to the end.
  5.  () ;
    Returns an iterator to the end.
  6.  () ;
    Returns an iterator to the end.
  7.  ( key);
    Find a variable by its name.
  8.  ( key) ;
    Find a variable by its name.
  9.  ( st) ;
    Number of variables.
  10.  ( id);

    Erase variable by id.

  11.  
    ( id,  value);
    Emplace an environment variable.
  12.  ();
    Check if environment has entries.
  13.  () ;
    Get the number of variables.
  14.  ();
    Clear the environment.
    [Note] Note

    Use with care, passed environment cannot be empty.

  15. entry_type ( key);
    Get the entry with the key. Throws if it does not exist.
  16. const_entry_type ( key) ;
    Get the entry with the key. Throws if it does not exist.
  17. entry_type ( key);
    Get the entry with the given key. It creates the entry if it doesn't exist.

PrevUpHomeNext