Interface nsIKeyValueServiceType

The key/value service. Enables retrieval of handles to key/value databases.

Hierarchy

Methods

AddRef QueryInterface Release getOrCreate

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

getOrCreate

  • Get a handle to an existing database or a newly-created one at the specified path and with the given name.

    The service supports multiple named databases at the same path (i.e. within the same storage file), so you can call this method multiple times with the same path and different names to retrieve multiple databases stored in the same location on disk.

    Parameters

    • callback: nsIKeyValueDatabaseCallback
    • path: string
    • name: string

    Returns void

Settings

Member Visibility

Theme

Generated using TypeDoc