Class: TArchiveIterator

Declaration: Archive.h

Taxonomy Categories:

Member Functions:

~TArchiveIterator
Next
First
TArchiveIterator

Interface Category:

API.

Inherits From:

MCollectible

Inherited By:

None.

Purpose:

TArchiveIterator iterates through the contents of an archive, returning a TArchiveKey representing each object. TArchiveIterator can iterate through a complete archive or just the contents of a particular locale within the archive.

Instantiation:

Allocate on the heap or the stack.

Deriving Classes:

This class is designed to be used directly. Do not derive.

Concurrency:

Not multithread safe.

Resource Use:

No special requirements.

Member Function: TArchiveIterator::~TArchiveIterator

virtual ~ TArchiveIterator ()

Interface Category:

API.

Purpose:

Destructor.

Calling Context:

Call this function directly.

Parameters:

Takes no parameters.

Return Value:

None.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not Multithread safe.

Other Considerations:

None.

Member Function: TArchiveIterator::Next

virtual bool Next (TArchiveKey & nextKey)

Interface Category:

API.

Purpose:

Fill in the given TArchiveKey with the next object found by the iterator. This function may be called repeatedly until all objects are found.

Calling Context:

Call this function directly.

Parameters:

TArchiveKey & nextKey -The TArchiveKey object to be filled in.

Return Value:

Returns true if an object was found, false otherwise.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not Multithread safe.

Other Considerations:

None.

Member Function: TArchiveIterator::First

virtual bool First (TArchiveKey & firstKey)

Interface Category:

API.

Purpose:

Fill in the given TArchiveKey with the first object found by the iterator.

Calling Context:

Call this function directly.

Parameters:

TArchiveKey & firstKey -The TArchiveKey object to be filled in.

Return Value:

Returns true if an object is found, false otherwise.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not Multithread safe.

Other Considerations:

None.

Member Function: TArchiveIterator::TArchiveIterator

TArchiveIterator (const TArchive *)
TArchiveIterator (const TArchive *, const TLocale &, bool includeInheritedItems =false)

Interface Category:

API.

Purpose:

Constructs an iterator for the contents of the given archive.
Constructs an iterator for the contents of the given locale within the given archive.

Calling Context:

Call this function directly.
Call this function directly.

Parameters:

const TArchive * -The archive over which this iterator iterates.
const TArchive * -The archive over which this iterator iterates.
const TLocale & -The locale over which this iterator iterates.
bool includeInheritedItems =false -Should inherited items be iterated over.

Return Value:

None.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not Multithread safe.

Other Considerations:

None.

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