Interface nsISimpleEnumeratorType

Hierarchy

Methods

  • Increases the reference count for this interface. The associated instance will not be deleted unless the reference count is returned to zero.

    Returns

    The resulting reference count.

    Returns number

  • Parameters

    • aIID: object
    • Optional aInstancePtr: object

    Returns any

  • A run time mechanism for interface discovery.

    Returns

    NS_OK if the interface is supported by the associated instance, NS_NOINTERFACE if it is not.

    aInstancePtr must not be null.

    Parameters

    • aIID: object

      [in] A requested interface IID

    • aInstancePtr: object

      [out] A pointer to an interface pointer to receive the result.

    Returns void

  • Decreases the reference count for this interface. Generally, if the reference count returns to zero, the associated instance is deleted.

    Returns

    The resulting reference count.

    Returns number

  • Returns JavaScript iterator for all remaining entries in the enumerator. Each entry is queried only to the supplied interface. If any element fails to query to that interface, the error is propagated to the caller.

    Parameters

    • aIface: object

    Returns nsIJSEnumerator

  • 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

    hasMoreElements()

    Throws

    NS_ERROR_FAILURE if there are no more elements to enumerate.

    Returns

    the next element in the enumeration.

    Returns nsISupports

  • 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

    getNext()

    Returns

    true if there are remaining elements in the enumerator. false if there are no more elements in the enumerator.

    Returns boolean

  • Returns a JavaScript iterator for all remaining entries in the enumerator. Each entry is typically queried to the appropriate interface for the enumerator.

    Returns nsIJSEnumerator

Generated using TypeDoc