Interface nsIInputStreamLengthCallbackType

This is a companion interface for nsIAsyncInputStreamLength::asyncLengthWait.

Hierarchy

Methods

AddRef QueryInterface Release onInputStreamLengthReady

Methods

AddRef

  • 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

QueryInterface

  • 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

Release

  • 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

onInputStreamLengthReady

  • Called to inform what the total length of the stream is.

    Parameters

    • aStream: nsIAsyncInputStreamLength

      The stream whose asyncLengthWait method was called.

    • aLength: number

      The stream's length. It can be -1 if the stream doesn't know its length. For instance, this can happen for a pipe inputStream.

    Returns void

Settings

Member Visibility

Theme

Generated using TypeDoc