Interface nsIBidirectionalIteratorType

...

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

  • Create a new iterator pointing to the same position in the underlying container or sequence to which this iterator currently points. The returned iterator is suitable for use in a subsequent call to |isEqualTo()| against this iterator.

    Result

    a new iterator pointing at the same position in the same underlying container or sequence as this iterator

    Returns nsISupports

  • Retrieve (and |AddRef()|) the element this iterator currently points to.

    The result is undefined if this iterator currently points outside the useful range of the underlying container or sequence.

    Result

    a new reference to the element this iterator currently points to (if any)

    Returns nsISupports

  • Test if |anotherIterator| points to the same position in the underlying container or sequence.

    The result is undefined if |anotherIterator| was not created by or for the same underlying container or sequence.

    Result

    true if |anotherIterator| points to the same position in the underlying container or sequence

    Parameters

    • anotherIterator: nsISupports

      another iterator to compare against, created by or for the same underlying container or sequence

    Returns boolean

  • Put |anElementToPut| into the underlying container or sequence at the position currently pointed to by this iterator. The iterator and the underlying container or sequence cooperate to |Release()| the replaced element, if any and if necessary, and to |AddRef()| the new element.

    The result is undefined if this iterator currently points outside the useful range of the underlying container or sequence.

    Parameters

    • anElementToPut: nsISupports

      the element to place into the underlying container or sequence

    Returns void

  • Move this iterator to the previous position in the underlying container or sequence.

    Returns void

  • Advance this iterator to the next position in the underlying container or sequence.

    Returns void

Generated using TypeDoc