nsIStringEnumerator

by 2 contributors:

Please add a summary to this article.
Inherits from: nsISupports Last changed in Gecko 1.7

Method overview

AString getNext();
boolean hasMore();

Methods

getNext()

Called to retrieve the next string in the enumerator. The "next" element is the first string upon the first call. Must be preceded by a call to hasMoreElements() which returns PR_TRUE. This method is generally called within a loop to iterate over the strings in the enumerator.

AString getNext();
Parameters

None.

Return value

The next string in the enumerator. Throws an exception if there are no more strings.

hasMore()

Called to determine whether or not the enumerator has any strings that can be returned via getNext(). This method is generally used to determine whether or not to initiate or continue iteration over the enumerator, though it can be called without subsequent getNext() calls. Does not affect internal state of enumerator.

boolean hasMore();
Parameters

None.

Return value

True if there are remaining strings in the enumerator. False if there are no more strings in the enumerator.

Document Tags and Contributors

Contributors to this page: Sheppy, Neil
Last updated by: Sheppy,