Interface nsIIOUtilType

nsIIOUtil provdes various xpcom/io-related utility methods.

Hierarchy

Methods

AddRef QueryInterface Release inputStreamIsBuffered outputStreamIsBuffered

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

inputStreamIsBuffered

  • Test whether an input stream is buffered. See nsStreamUtils.h documentation for NS_InputStreamIsBuffered for the definition of "buffered" used here and for edge-case behavior.

    Throws

    NS_ERROR_INVALID_POINTER if null is passed in.

    Parameters

    • aStream: nsIInputStream

    Returns boolean

outputStreamIsBuffered

  • Test whether an output stream is buffered. See nsStreamUtils.h documentation for NS_OutputStreamIsBuffered for the definition of "buffered" used here and for edge-case behavior.

    Throws

    NS_ERROR_INVALID_POINTER if null is passed in.

    Parameters

    • aStream: nsIOutputStream

    Returns boolean

Settings

Member Visibility

Theme

Generated using TypeDoc