Taxonomy Categories:
Member Functions:
Interface Category:
API.
Inherits From:
None.
Inherited By:
None.
Purpose:
Allows you to iterate over all the associations in a TDiskDictionaryOf.
Instantiation:
Allocate on the heap or the stack.
Deriving Classes:
None.
Concurrency:
Not multithread safe.
Resource Use:
No special requirements.
Other Considerations:
None.
TDiskDictionaryIteratorOf (const TDiskDictionaryOf < AKey, AValue >*)
Interface Category:
API.
Purpose:
Constructor. Creates a TDiskDictionaryIteratorOf for the TDiskDictionaryOf passed in.
Calling Context:
Called at construction to create an iterator for a TDiskDictionaryOf.
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.
~ TDiskDictionaryIteratorOf ()
Interface Category:
API.
Purpose:
Destructor. Releases the resources associated with the TDiskDictionaryIteratorOf.
Calling Context:
Called to destroy an object.
Parameters:
Return Value:
None.
Exceptions:
Throws no exceptions.
Concurrency:
Not multithread safe.
Other Considerations:
Does not destroy the associated TDiskDictionaryOf.
void Reset ()
Interface Category:
API.
Purpose:
Resynchronizes with the associated disk dictionary.
Calling Context:
Called to resync with the associated disk dictionary.
Parameters:
Return Value:
None.
Exceptions:
Throws no exceptions.
Concurrency:
Not multithread safe.
Other Considerations:
None.
TKeyValuePair < AKey , AValue >* First ()
Interface Category:
API.
Purpose:
Retrieves the first key-value pair of the disk dictionary.
Calling Context:
Called to retrieve the first key-value pair of the disk dictionary.
Parameters:
Return Value:
Returns the first key-value pair of the disk dictionary, NIL if no entries in the disk dictionary.
Exceptions:
Throws a derived class of TPersistentStorageException if an internal failure occurred.
Concurrency:
Not multithread safe.
Other Considerations:
None.
TKeyValuePair < AKey , AValue >* Next ()
Interface Category:
API.
Purpose:
Retrieves the next key-value pair of the disk dictionary.
Calling Context:
Called to retrieve the next key-value pair of the disk dictionary.
Parameters:
Return Value:
Returns the next key-value pair of the disk dictionary, NIL if the iteration is complete.
Exceptions:
Throws a derived class of TPersistentStorageException if an internal failure occurred.
Concurrency:
Not multithread safe.
Other Considerations:
None.
AKey * FirstKey ()
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, NIL if no entries exist in the disk dictionary.
Exceptions:
Throws a derived class of TPersistentStorageException if an internal failure occurred.
Concurrency:
Not multithread safe.
Other Considerations:
None.
AKey * NextKey ()
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, NIL when the iteration is complete.
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.