Class: TArchiveLocaleIterator

Declaration: Archive.h

Taxonomy Categories:

Member Functions:

~TArchiveLocaleIterator
ComputeSetOfLocales
Next
First
TArchiveLocaleIterator

Interface Category:

API.

Inherits From:

MCollectible

Inherited By:

None.

Purpose:

TArchiveLocaleIterator iterates through the various locales within an archive, returning a TLocale instance for each locale.

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: TArchiveLocaleIterator::~TArchiveLocaleIterator

virtual ~ TArchiveLocaleIterator ()

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: TArchiveLocaleIterator::ComputeSetOfLocales

virtual void ComputeSetOfLocales ()

Interface Category:

API.

Purpose:

Computes the set of locales contained by the archive.

Calling Context:

Called by sub-classes to initialize the iterator.

Parameters:

Takes no parameters.

Return Value:

None.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not Multithread safe.

Other Considerations:

None.

Member Function: TArchiveLocaleIterator::Next

virtual bool Next (TLocale & nextLocale)

Interface Category:

API.

Purpose:

Fills in the given TLocale with the next locale found by the iterator. This function may be called repeatedly until all objects are found.

Calling Context:

Call this function directly.

Parameters:

TLocale & nextLocale -The TLocale object to be filled in.

Return Value:

Returns true if a locale object was found, false otherwise.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not Multithread safe.

Other Considerations:

None.

Member Function: TArchiveLocaleIterator::First

virtual bool First (TLocale & firstLocale)

Interface Category:

API.

Purpose:

Fills in the given TLocale with the first locale found by the iterator.

Calling Context:

Call this function directly.

Parameters:

TLocale & firstLocale -The TLocale object to be filled in.

Return Value:

Returns true if a locale object was found, false otherwise.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not Multithread safe.

Other Considerations:

None.

Member Function: TArchiveLocaleIterator::TArchiveLocaleIterator

TArchiveLocaleIterator (const TArchive *)

Interface Category:

API.

Purpose:

Constructs an iterator for the locales containing objects in the given archive.

Calling Context:

Call this function directly.

Parameters:

const TArchive * -The archive over which to iterate.

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.