Rudiments
|
Static Public Member Functions | |
static const char * | getValue (const char *variable) |
static bool | setValue (const char *variable, const char *value) |
static bool | remove (const char *variable) |
static const char *const | variables () |
static bool | clear () |
static void | print () |
static void | setMutex (mutex *mtx) |
The environment class provides methods for accessing and manipulating environment variables.
static bool environment::clear | ( | ) | [static] |
Clears the environment of all name-value pairs. After calling this, variables() will return NULL.
static const char* environment::getValue | ( | const char * | variable | ) | [static] |
Returns the value of "variable".
static void environment::print | ( | ) | [static] |
Prints the environment variable list to stdout.
static bool environment::remove | ( | const char * | variable | ) | [static] |
Removes "variable" from the environment.
static void environment::setMutex | ( | mutex * | mtx | ) | [static] |
Allows you to supply a mutex if the class needs it. If your application is not multithreaded, then there is no need to supply a mutex.
static bool environment::setValue | ( | const char * | variable, |
const char * | value | ||
) | [static] |
Sets the value of "variable" to "value", overwriting any value that "variable" previously had. Returns true on success and false on failure.
static const char* const environment::variables | ( | ) | [static] |
Returns a NULL terminated list of all environment variables. Each entry in the list is of the form NAME=VALUE.