Management of system environment variables An environment variable is composed of a variable name and its value. More...

#include <OSD_Environment.hxx>

Public Member Functions
	OSD_Environment ()
	Creates the object Environment.

	OSD_Environment (const TCollection_AsciiString &Name)
	Creates an Environment variable initialized with value set to an empty AsciiString.

	OSD_Environment (const TCollection_AsciiString &Name, const TCollection_AsciiString &Value)
	Creates an Environment variable initialized with Value.

void	SetValue (const TCollection_AsciiString &Value)
	Changes environment variable value. Raises ConstructionError either if the string contains characters not in range of ' '...'~' or if the string contains the character '$' which is forbidden.

TCollection_AsciiString	Value ()
	Gets the value of an environment variable.

void	SetName (const TCollection_AsciiString &name)
	Changes environment variable name. Raises ConstructionError either if the string contains characters not in range of ' '...'~' or if the string contains the character '$' which is forbidden.

TCollection_AsciiString	Name () const
	Gets the name of <me>.

void	Build ()
	Sets the value of an environment variable into system (physically).

void	Remove ()
	Removes (physically) an environment variable.

bool	Failed () const
	Returns TRUE if an error occurs.

void	Reset ()
	Resets error counter to zero.

void	Perror ()
	Raises OSD_Error.

int	Error () const
	Returns error number if 'Failed' is TRUE.

Detailed Description

Management of system environment variables An environment variable is composed of a variable name and its value.

To be portable among various systems, environment variables are local to a process.

Constructor & Destructor Documentation

◆ OSD_Environment() [1/3]

OSD_Environment::OSD_Environment ( )

Creates the object Environment.

◆ OSD_Environment() [2/3]

OSD_Environment::OSD_Environment ( const TCollection_AsciiString & Name )

Creates an Environment variable initialized with value set to an empty AsciiString.

◆ OSD_Environment() [3/3]

OSD_Environment::OSD_Environment	(	const TCollection_AsciiString &	Name,
		const TCollection_AsciiString &	Value )

Creates an Environment variable initialized with Value.

Member Function Documentation

◆ Build()

void OSD_Environment::Build ( )

Sets the value of an environment variable into system (physically).

◆ Error()

int OSD_Environment::Error ( ) const

Returns error number if 'Failed' is TRUE.

◆ Failed()

bool OSD_Environment::Failed ( ) const

Returns TRUE if an error occurs.

◆ Name()

TCollection_AsciiString OSD_Environment::Name ( ) const

Gets the name of <me>.

◆ Perror()

void OSD_Environment::Perror ( )

Raises OSD_Error.

◆ Remove()

void OSD_Environment::Remove ( )

Removes (physically) an environment variable.

◆ Reset()

void OSD_Environment::Reset ( )

Resets error counter to zero.

◆ SetName()

void OSD_Environment::SetName ( const TCollection_AsciiString & name )

Changes environment variable name. Raises ConstructionError either if the string contains characters not in range of ' '...'~' or if the string contains the character '$' which is forbidden.

◆ SetValue()

void OSD_Environment::SetValue ( const TCollection_AsciiString & Value )

Changes environment variable value. Raises ConstructionError either if the string contains characters not in range of ' '...'~' or if the string contains the character '$' which is forbidden.

◆ Value()

TCollection_AsciiString OSD_Environment::Value ( )

Gets the value of an environment variable.

The documentation for this class was generated from the following file:

OSD_Environment.hxx

Public Member Functions