This allows consultation of every environment variable. There is no specific order of results. More...

#include <OSD_EnvironmentIterator.hxx>

Public Member Functions
	OSD_EnvironmentIterator ()
	Instantiates Object as Iterator;. More...

void	Destroy ()

	~OSD_EnvironmentIterator ()

Standard_Boolean	More ()
	Returns TRUE if there are other environment variables. More...

void	Next ()
	Sets the iterator to the next item. Returns the item value corresponding to the current position of the iterator. More...

OSD_Environment	Values ()
	Returns the next environment variable found. More...

Standard_Boolean	Failed () const
	Returns TRUE if an error occurs. More...

void	Reset ()
	Resets error counter to zero. More...

void	Perror ()
	Raises OSD_Error. More...

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

Detailed Description

This allows consultation of every environment variable. There is no specific order of results.

Constructor & Destructor Documentation

OSD_EnvironmentIterator::OSD_EnvironmentIterator ( )

Instantiates Object as Iterator;.

OSD_EnvironmentIterator::~OSD_EnvironmentIterator ( )

inline

void OSD_EnvironmentIterator::Destroy ( )

Standard_Integer OSD_EnvironmentIterator::Error ( ) const

Returns error number if 'Failed' is TRUE.

Standard_Boolean OSD_EnvironmentIterator::Failed ( ) const

Returns TRUE if an error occurs.

Standard_Boolean OSD_EnvironmentIterator::More ( )

Returns TRUE if there are other environment variables.

void OSD_EnvironmentIterator::Next ( )

Sets the iterator to the next item. Returns the item value corresponding to the current position of the iterator.

void OSD_EnvironmentIterator::Perror ( )

void OSD_EnvironmentIterator::Reset ( )

Resets error counter to zero.

OSD_Environment OSD_EnvironmentIterator::Values ( )

Returns the next environment variable found.

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