Taxonomy Categories:
Member Functions:
Interface Category:
API.
Inherits From:
None.
Inherited By:
None.
Purpose:
This class provides an iterator over the keys contained in a THeterogenousDiskDictionaryOf<AKey>.
Instantiation:
Allocate on the heap or the stack.
Deriving Classes:
None.
Concurrency:
Not multithread safe.
Resource Use:
No special requirements.
Other Considerations:
None.
THeterogenousDiskDictionaryOfIterator (const THeterogenousDiskDictionaryOf < AKey > * dictionaryAlias)
Interface Category:
API.
Purpose:
Constructor. Creates a THeterogenousDiskDictionaryOfIterator for the THeterogenousDiskDictionaryOf passed in.
Calling Context:
Called at construction to create an iterator for a THeterogenousDiskDictionaryOfIterator.
Parameters:
Return Value:
None.
Exceptions:
Throws TDiskDictionaryInvalidArgumentsException::kInvalidArguments if a bad parameter is used in the constructor.
Throws a derived class of TPersistentStorageException if an internal failure occurred.
Concurrency:
Not multithread safe.
Other Considerations:
None.
~ THeterogenousDiskDictionaryOfIterator ()
Interface Category:
API.
Purpose:
Destructor.
Calling Context:
Called to destroy an object.
Parameters:
Return Value:
None.
Exceptions:
Throws no exceptions, passes all exceptions through.
Concurrency:
Not multithread safe.
Other Considerations:
None.
AKey * CopyFirst ()
Interface Category:
API.
Purpose:
Retrieves the first key object in the associated disk dictionary.
Calling Context:
Called to retrieve the first key object in the associated disk dictionary.
Parameters:
Return Value:
Returns the first key object in the associated disk dictionary, or NIL if there are no keys.
Exceptions:
Throws a derived class of TPersistentStorageException if an internal failure occurred.
Concurrency:
Not multithread safe.
Other Considerations:
None.
AKey * CopyNext ()
Interface Category:
API.
Purpose:
Retrieves the next key object in the associated disk dictionary.
Calling Context:
Called to retrieve the next key object in the associated disk dictionary.
Parameters:
Return Value:
Returns the next key object in the associated disk dictionary, or NIL if there are no more keys.
Exceptions:
Throws a derived class of TPersistentStorageException if an internal failure occurred.
Concurrency:
Not multithread safe.
Other Considerations:
None.
Click the icon to mail questions or corrections about this material to Taligent personnel.
Copyright©1995 Taligent,Inc. All rights reserved.