xpcom/ds/nsISimpleEnumerator.idlScriptable
This interface represents an enumeration of XPCOM objects and provides methods to access elements sequentially.
Inherits from: nsISupports Last changed in Gecko 0.9.6

Method overview

nsISupports getNext();
boolean hasMoreElements();

Methods

getNext()

Called to retrieve the next element in the enumerator. The "next" element is the first element 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 elements in the enumerator.

nsISupports getNext();
Parameters

None.

Return value

NS_OK if the call succeeded in returning a non-null value through the out parameter. NS_ERROR_FAILURE if there are no more elements to enumerate.

hasMoreElements()

Called to determine whether or not the enumerator has any elements 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 hasMoreElements();
Parameters

None.

Return value

PR_TRUE if there are remaining elements in the enumerator. PR_FALSE if there are no more elements in the enumerator.

Remarks

This interface was frozen for Gecko 0.9.6. See bug 154047 for details. From Gecko 2.0 interfaces are no longer frozen.

See also