OSD_DirectoryIterator Class Reference

Manages a breadth-only search for sub-directories in the specified Path. There is no specific order of results. More...

#include <OSD_DirectoryIterator.hxx>

Public Member Functions
	OSD_DirectoryIterator ()
	Instantiates Object as empty Iterator;. More...
	OSD_DirectoryIterator (const OSD_Path &where, const TCollection_AsciiString &Mask)
	Instantiates Object as Iterator. Wild-card "*" can be used in Mask the same way it is used by unix shell for file names. More...
void	Destroy ()
	~OSD_DirectoryIterator ()
void	Initialize (const OSD_Path &where, const TCollection_AsciiString &Mask)
	Initializes the current File Directory. More...
Standard_Boolean	More ()
	Returns TRUE if other items are found while using the 'Tree' method. More...
void	Next ()
	Sets the iterator to the next item. Returns the item value corresponding to the current position of the iterator. More...
OSD_Directory	Values ()
	Returns the next item 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

Manages a breadth-only search for sub-directories in the specified Path. There is no specific order of results.

Constructor & Destructor Documentation

OSD_DirectoryIterator() [1/2]

OSD_DirectoryIterator::OSD_DirectoryIterator

(

)

Instantiates Object as empty Iterator;.

OSD_DirectoryIterator() [2/2]

OSD_DirectoryIterator::OSD_DirectoryIterator	(	const OSD_Path &	where,
		const TCollection_AsciiString &	Mask
	)

Instantiates Object as Iterator. Wild-card "*" can be used in Mask the same way it is used by unix shell for file names.

~OSD_DirectoryIterator()

OSD_DirectoryIterator::~OSD_DirectoryIterator ( )

inline

Member Function Documentation

Destroy()

void OSD_DirectoryIterator::Destroy

(

)

Error()

Standard_Integer OSD_DirectoryIterator::Error

(

)

const

Returns error number if 'Failed' is TRUE.

Failed()

Standard_Boolean OSD_DirectoryIterator::Failed

(

)

const

Returns TRUE if an error occurs.

Initialize()

void OSD_DirectoryIterator::Initialize	(	const OSD_Path &	where,
		const TCollection_AsciiString &	Mask
	)

Initializes the current File Directory.

More()

Standard_Boolean OSD_DirectoryIterator::More

(

)

Returns TRUE if other items are found while using the 'Tree' method.

Next()

void OSD_DirectoryIterator::Next

(

)

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

Perror()

void OSD_DirectoryIterator::Perror

(

)

Raises OSD_Error.

Reset()

void OSD_DirectoryIterator::Reset

(

)

Resets error counter to zero.

Values()

OSD_Directory OSD_DirectoryIterator::Values

(

)

Returns the next item found .

---

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

• OSD_DirectoryIterator.hxx