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

#include <OSD_Environment.hxx>

Public Member Functions
void *	operator new (size_t, void *anAddress)
void *	operator new (size_t size)
void	operator delete (void *anAddress)
	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 forbiden.
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 forbiden.
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
Standard_Boolean	Failed () const
	Returns TRUE if an error occurs
void	Reset ()
	Resets error counter to zero
void	Perror ()
	Raises OSD_Error
Standard_Integer	Error () const
	Returns error number if 'Failed' is TRUE.

Constructor & Destructor Documentation

OSD_Environment::OSD_Environment ( )

OSD_Environment::OSD_Environment ( const TCollection_AsciiString & Name )

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

Member Function Documentation

void OSD_Environment::Build ( )

Standard_Integer OSD_Environment::Error ( ) const

Standard_Boolean OSD_Environment::Failed ( ) const

TCollection_AsciiString OSD_Environment::Name ( ) const

void OSD_Environment::operator delete ( void * anAddress ) [inline]

void* OSD_Environment::operator new ( size_t size ) [inline]

void* OSD_Environment::operator new	(	size_t	,
		void *	anAddress
	)		`[inline]`

void OSD_Environment::Perror ( )

void OSD_Environment::Remove ( )

void OSD_Environment::Reset ( )

void OSD_Environment::SetName ( const TCollection_AsciiString & name )

void OSD_Environment::SetValue ( const TCollection_AsciiString & Value )

TCollection_AsciiString OSD_Environment::Value ( )

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