Open CASCADE Technology  7.3.0
Public Member Functions

OSD_FileIterator Class Reference

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

#include <OSD_FileIterator.hxx>

Public Member Functions

 OSD_FileIterator ()
 Instantiates Object as empty Iterator;. More...
 
 OSD_FileIterator (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_FileIterator ()
 
void Initialize (const OSD_Path &where, const TCollection_AsciiString &Mask)
 Initializes the current File Iterator. More...
 
Standard_Boolean More ()
 Returns TRUE if there are other items 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_File Values ()
 Returns the next file 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 files in the specified Path. There is no specific order of results.

Constructor & Destructor Documentation

◆ OSD_FileIterator() [1/2]

OSD_FileIterator::OSD_FileIterator ( )

Instantiates Object as empty Iterator;.

◆ OSD_FileIterator() [2/2]

OSD_FileIterator::OSD_FileIterator ( 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_FileIterator()

OSD_FileIterator::~OSD_FileIterator ( )
inline

Member Function Documentation

◆ Destroy()

void OSD_FileIterator::Destroy ( )

◆ Error()

Standard_Integer OSD_FileIterator::Error ( ) const

Returns error number if 'Failed' is TRUE.

◆ Failed()

Standard_Boolean OSD_FileIterator::Failed ( ) const

Returns TRUE if an error occurs.

◆ Initialize()

void OSD_FileIterator::Initialize ( const OSD_Path where,
const TCollection_AsciiString Mask 
)

Initializes the current File Iterator.

◆ More()

Standard_Boolean OSD_FileIterator::More ( )

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

◆ Next()

void OSD_FileIterator::Next ( )

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

◆ Perror()

void OSD_FileIterator::Perror ( )

Raises OSD_Error.

◆ Reset()

void OSD_FileIterator::Reset ( )

Resets error counter to zero.

◆ Values()

OSD_File OSD_FileIterator::Values ( )

Returns the next file found .


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