Public Types | Static Public Member Functions

zeus::TEnvironmentVariables Class Reference

#include <EnvironmentVariables.h>

List of all members.

Public Types

enum  ESettingMethod { etCurrentProcess, etPersistentlyCurrentUser, etPersistentlyLocalMachine }
 

Enum for the setting method.

More...

Static Public Member Functions

static bool deleteEnvironmentVariable (const IString &strName, ESettingMethod eMethod)
 Deletes an environment variable.
static TString getEnvironmentVariable (const IString &strName)
 Get an environment variable.
static bool setEnvironmentVariable (const IString &strName, const IString &strValue, ESettingMethod eMethod)
 Set an environment variable.

Detailed Description

Static class for all operations with OS environment variables.


Member Enumeration Documentation

Enum for the setting method.

Enumerator:
etCurrentProcess 
etPersistentlyCurrentUser 
etPersistentlyLocalMachine 

Member Function Documentation

bool zeus::TEnvironmentVariables::deleteEnvironmentVariable ( const IString strName,
ESettingMethod  eMethod 
) [static]

Deletes an environment variable.

Deletes an environment variable.

Parameters:
strName[IN]: Name of the variable.
eMethod[IN]: Setting method.
Return values:
true,:variable deleted
false,:could not delete the variable
TString zeus::TEnvironmentVariables::getEnvironmentVariable ( const IString strName ) [static]

Get an environment variable.

Get an environment variable.

Parameters:
strName[IN]: Name of the variable.
Returns:
: Value of the variable. Empty if undefined.
bool zeus::TEnvironmentVariables::setEnvironmentVariable ( const IString strName,
const IString strValue,
ESettingMethod  eMethod 
) [static]

Set an environment variable.

Set an environment variable.

Parameters:
strName[IN]: Name of the variable.
strValue[IN]: Wert of the variable.
eMethod[IN]: Setting method.
Return values:
true,:Variable set
false,:could not set the variable

The documentation for this class was generated from the following files:
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Defines


Written by Benjamin Hadorn http://www.xatlantis.ch.
Last change made on Sun Jan 22 2012 15:28:33