Public Member Functions

nsISimpleEnumerator Interface Reference

Used to enumerate over elements defined by its implementor. More...

import "nsISimpleEnumerator.idl";

Inheritance diagram for nsISimpleEnumerator:

List of all members.

Public Member Functions

boolean hasMoreElements ()
 Called to determine whether or not the enumerator has any elements that can be returned via getNext().
nsISupports getNext ()
 Called to retrieve the next element in the enumerator.

Detailed Description

Used to enumerate over elements defined by its implementor.

Although hasMoreElements() can be called independently of getNext(), getNext() must be pre-ceeded by a call to hasMoreElements(). There is no way to "reset" an enumerator, once you obtain one.

Version:
1.0

Member Function Documentation

nsISupports nsISimpleEnumerator::getNext (  ) 

Called to retrieve the next element in the enumerator.

The "next" element is the first element upon the first call. Must be pre-ceeded 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.

See also:
hasMoreElements()
Returns:
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.
the next element in the enumeration.
boolean nsISimpleEnumerator::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.

See also:
getNext()
Returns:
PR_TRUE if there are remaining elements in the enumerator. PR_FALSE if there are no more elements in the enumerator.

The documentation for this interface was generated from the following file: