Open CASCADE Technology 6.6.0
Public Member Functions
OSD_DirectoryIterator Class Reference

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

#include <OSD_DirectoryIterator.hxx>

Public Member Functions

 OSD_DirectoryIterator ()
 Instantiates Object as empty Iterator;

 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

void Destroy ()
 ~OSD_DirectoryIterator ()
void Initialize (const OSD_Path &where, const TCollection_AsciiString &Mask)
 Initializes the current File Directory

Standard_Boolean More ()
 Returns TRUE if other items are found while
using the 'Tree' method.

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

OSD_Directory Values ()
 Returns the next item found .

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_DirectoryIterator::OSD_DirectoryIterator ( )
OSD_DirectoryIterator::OSD_DirectoryIterator ( const OSD_Path where,
const TCollection_AsciiString Mask 
)
OSD_DirectoryIterator::~OSD_DirectoryIterator ( ) [inline]

Member Function Documentation

void OSD_DirectoryIterator::Destroy ( )
Standard_Integer OSD_DirectoryIterator::Error ( ) const
Standard_Boolean OSD_DirectoryIterator::Failed ( ) const
void OSD_DirectoryIterator::Initialize ( const OSD_Path where,
const TCollection_AsciiString Mask 
)
Standard_Boolean OSD_DirectoryIterator::More ( )
void OSD_DirectoryIterator::Next ( )
void OSD_DirectoryIterator::Perror ( )
void OSD_DirectoryIterator::Reset ( )
OSD_Directory OSD_DirectoryIterator::Values ( )

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