RiverSoftAVG Products Help

Zoom Window Out
Larger Text | Smaller Text
Hide Page Header
Show Expanding Text
Printable Version
Send Mail Feedback
Save Permalink URL

Navigation: Code Documentation > RSCommon > RSGenerics.Collections > Classes

TRSStringHashTable<TValue>.TStringIterator Class

TRSStringHashTable.TStringIterator is the enumerator class for the string keys in the dictionary, that also implements the CommonInterfaces.IStringIterator interface.

TRSStringHashTable.TStringIterator is the class that implements enumerating functionality to the collection of string keys in the dictionary.

The IStringIterator interface is similar to an Enumeration in java.

To use the iterator is simple, get the iterator and then keep calling the RSGenerics.Collections.TRSStringHashTable<TValue>.TStringIterator.NextElement method until the RSGenerics.Collections.TRSStringHashTable<TValue>.TStringIterator.HasMoreElements method returns False. The iterator works by giving you the next element until the end of the list, there is no provision for getting the previous element.

Namespace: RSGenerics.Collections

	Name	Description
	CurrentElement	Returns the current string key in the enumeration, your "place" in the enumeration. When the iterator is first supplied or when it is Reset, there is no current element (calling this method in such a case should raise an exception). Only after the first call to the NextElement method will this method return a value. Unlike the NextElement method which returns a new value every time you call it, this method always returns the same value no matter how many times you call it (until NextElement is called, of course).
	GetCount	Returns the number of items left in the enumeration. Accessor method for RSGenerics.Collections.TRSStringHashTable<TValue>.TStringIterator.Count property.
	get_Count	Returns the number of items left in the enumeration. Accessor method for RSGenerics.Collections.TRSStringHashTable<TValue>.TStringIterator.Count property.
	HasMoreElements	Returns True if there are more elements to retrieve from the enumeration. While this method returns true, the RSGenerics.Collections.TRSStringHashTable<TValue>.TStringIterator.NextElement method should not raise an exception.
	NextElement	Returns the next string key in the enumeration. If there are no more items, the method should raise an exception. To check if there are more items, use the RSGenerics.Collections.TRSStringHashTable<TValue>.TStringIterator.HasMoreElements method. The NextElement method advances its place in the enumeration and then returns that item. Every call to NextElement returns a new item (until the end of the enumeration). If you wish to access the current item multiple times in a loop, use the RSGenerics.Collections.TRSStringHashTable<TValue>.TStringIterator.CurrentElement method.
	Reset	Resets the iterator to the beginning of the enumeration.

Top

RiverSoftAVG Products Help

Reference