Interface nsIFileRandomAccessStreamType

A stream that allows you to read from a file or stream to a file.

Hierarchy

Methods

AddRef QueryInterface Release deserialize getInputStream getOutputStream init inputStream outputStream seek serialize setEOF tell

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

deserialize

getInputStream

getOutputStream

init

  • Parameters

    • file: nsIFile

      file to read from or stream to

    • ioFlags: number

      file open flags listed in prio.h (see PR_Open documentation) or -1 to open the file in default mode (PR_RDWR).

    • perm: number

      file mode bits listed in prio.h or -1 to use the default value (0)

    • behaviorFlags: number

      flags specifying various behaviors of the class (see enumerations in the class)

    Returns void

inputStream

outputStream

seek

  • seek

    This method moves the stream offset of the steam implementing this interface.

    Throws

    NS_BASE_STREAM_CLOSED if called on a closed stream.

    Parameters

    • whence: number

      specifies how to interpret the 'offset' parameter in setting the stream offset associated with the implementing stream.

    • offset: number

      specifies a value, in bytes, that is used in conjunction with the 'whence' parameter to set the stream offset of the implementing stream. A negative value causes seeking in the reverse direction.

    Returns void

serialize

  • Parameters

    • aCallbacks: nsIInterfaceRequestor

    Returns RandomAccessStreamParams

setEOF

  • setEOF

    This method truncates the stream at the current offset.

    Throws

    NS_BASE_STREAM_CLOSED if called on a closed stream.

    Returns void

tell

  • tell

    This method reports the current offset, in bytes, from the start of the stream.

    Throws

    NS_BASE_STREAM_CLOSED if called on a closed stream.

    Returns number

Settings

Member Visibility

Theme

Generated using TypeDoc