Interface mozIStorageFunctionType

mozIStorageFunction is to be implemented by storage consumers that wish to receive callbacks during the request execution.

SQL can apply functions to values from tables. Examples of such functions are MIN(a1,a2) or SQRT(num). Many functions are implemented in SQL engine.

This interface allows consumers to implement their own, problem-specific functions. These functions can be called from triggers, too.

Hierarchy

Methods

AddRef QueryInterface Release onFunctionCall

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

onFunctionCall

  • onFunctionCall is called when execution of a custom function should occur.

    Returns

    any value as Variant type.

    Parameters

    • aFunctionArguments: mozIStorageValueArray

      The arguments passed in to the function

    Returns nsIVariant

Settings

Member Visibility

Theme

Generated using TypeDoc