Main Page | Namespace List | Class Hierarchy | Alphabetical List | Class List | File List | Namespace Members | Class Members | File Members

props.h File Reference

A Dv::Util::Props class object represents a set of key-value pairs (aka property list). More...

#include <string>
#include <iterator>
#include <iostream>
#include <map>
#include <stdexcept>

Include dependency graph for props.h:

Include dependency graph

Go to the source code of this file.

Namespaces

namespace  Dv
namespace  Dv::Util

Classes

class  Dv::Util::PropsException
 Exception class associated with Props. More...
class  Dv::Util::Props
 A propert list class. More...
class  Dv::Util::Props::Value
 A class representing a reference to a key-value pair in a Props object. More...
class  Dv::Util::Props::ConstValue
 A class representing a reference to a key-value pair in a Props object. More...

Functions

Props & env2props (Props &props)
 This function adds its environment to its props parameter.


Detailed Description

A Dv::Util::Props class object represents a set of key-value pairs (aka property list).

Prop object can be written to and read from a stream, making them suitable to implement e.g. configuration files.

The Dv::Util::env2props(Props&) function loads the shell environment (man getenv) into a Dv::Util::Props object.

Definition in file props.h.


Function Documentation

Props& env2props Props &  props  ) 
 

This function adds its environment to its props parameter.

It returns a reference to its parameter. See man (5) environ for information about the environment.

Parameters:
props to add environment variables to.
Returns:
reference to props.


dvutil-0.13.15 [30 December, 2004]