Interface nsIScriptableInputStreamType

nsIScriptableInputStream provides scriptable access to an nsIInputStream instance.

Hierarchy

Methods

AddRef QueryInterface Release available close init read readBytes

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

available

  • Return the number of bytes currently available in the stream

    Returns

    the number of bytes

    Throws

    NS_BASE_STREAM_CLOSED if called after the stream has been closed

    Returns number

close

  • Closes the stream.

    Returns void

init

  • Wrap the given nsIInputStream with this nsIScriptableInputStream.

    Parameters

    • aInputStream: nsIInputStream

      parameter providing the stream to wrap

    Returns void

read

  • Read data from the stream.

    WARNING: If the data contains a null byte, then this method will return a truncated string.

    Returns

    the data, which will be an empty string if the stream is at EOF.

    Throws

    NS_BASE_STREAM_CLOSED if called after the stream has been closed

    Throws

    NS_ERROR_NOT_INITIALIZED if init was not called

    Parameters

    • aCount: number

      the maximum number of bytes to read

    Returns string

readBytes

  • Read data from the stream, including NULL bytes.

    Returns

    the data from the stream, which will be an empty string if EOF has been reached.

    Throws

    NS_BASE_STREAM_WOULD_BLOCK if reading from the input stream would block the calling thread (non-blocking mode only).

    Throws

    NS_ERROR_FAILURE if there are not enough bytes available to read aCount amount of data.

    Parameters

    • aCount: number

      the maximum number of bytes to read.

    Returns string

Settings

Member Visibility

Theme

Generated using TypeDoc