Class: TDirectoryTreeIterator

Declaration: FileSystemInterface.h

Taxonomy Categories:

Member Functions:

Interface Category:

API.

Inherits From:

TDirectoryIterator

Inherited By:

None.

Purpose:

Recursively iterates over the contents of a directory, depth-first.

Instantiation:

Allocate on the heap or the stack. The stack is preferred.

Deriving Classes:

Do not derive from this class.

Concurrency:

Not multithread safe.

Resource Use:

No special requirements.

Member Function: TDirectoryTreeIterator::~TDirectoryTreeIterator

virtual ~ TDirectoryTreeIterator ()

Interface Category:

API.

Purpose:

Destructor.

Calling Context:

Called to destroy an object.

Parameters:

Takes no parameters.

Return Value:

None.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe. This is a handle class.

Other Considerations:

None.

Member Function: TDirectoryTreeIterator::operator=

TDirectoryTreeIterator & operator =(const TDirectoryTreeIterator & right)

Interface Category:

API.

Purpose:

Assignment operator.

Calling Context:

Called when an object is assigned to another compatible object.

Parameters:

const TDirectoryTreeIterator & right -The object being assigned from.

Return Value:

A non-const reference to the left-hand side object.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe. This is a handle class.

Other Considerations:

None.

Member Function: TDirectoryTreeIterator::TDirectoryTreeIterator

TDirectoryTreeIterator ()
TDirectoryTreeIterator (const TDirectory & directory, const TPropertyIDSet & properties =kNoProperties, const TPropertyQuery & aQuery =kNoQuery)
TDirectoryTreeIterator (const TDirectoryTreeIterator & copy)

Interface Category:

API.

Purpose:

Default constructor.
Constructs an iterator to find entities that satisfy aQuery and to return their properties.
Copy constructor.

Calling Context:

Called by the stream-in operators, or directly for later assignment.
Call this function directly.
Called to copy an object.

Parameters:

Takes no parameters.
const TDirectory & directory -The directory to enumerate.
const TPropertyIDSet & properties =kNoProperties -The properties to fill in for each item.
const TPropertyQuery & aQuery =kNoQuery -Returns, in an enumeration, only items satisfying this query.
const TDirectoryIterator & copy -The iterator to copy.

Return Value:

None.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe. This is a handle class.

Other Considerations:

None.

Click the icon to mail questions or corrections about this material to Taligent personnel.