Interface nsIBackgroundFileSaverObserverType

Hierarchy

Methods

AddRef QueryInterface Release onSaveComplete onTargetChange

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

onSaveComplete

  • Called when the operation completed, and the target file has been closed. If the operation succeeded, the target file is ready to be used, otherwise it might have been already deleted.

    Parameters

    • aSaver: nsIBackgroundFileSaver

      Reference to the object that raised the notification.

    • aStatus: number

      Result code that determines whether the operation succeeded or failed, as well as the failure reason.

    Returns void

onTargetChange

  • Called when the name of the output file has been determined. This function may be called more than once if the target file is renamed while saving.

    Parameters

    • aSaver: nsIBackgroundFileSaver

      Reference to the object that raised the notification.

    • aTarget: nsIFile

      Name of the file that is being written.

    Returns void

Settings

Member Visibility

Theme

Generated using TypeDoc