Interface mozIStorageValueArrayType

mozIStorageValueArray wraps an array of SQL values, such as a single database row.

Hierarchy

Properties

numEntries

Methods

AddRef QueryInterface Release getBlob getBlobAsString getBlobAsUTF8String getDouble getInt32 getInt64 getIsNull getSharedBlob getSharedString getSharedUTF8String getString getTypeOfIndex getUTF8String

Properties

Readonly numEntries

numEntries: number

numEntries

number of entries in the array (each corresponding to a column in the database row)

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

getBlob

  • Parameters

    • aIndex: number
    • aDataSize: number
    • aData: number

    Returns void

getBlobAsString

  • Parameters

    • aIndex: number

    Returns string

getBlobAsUTF8String

  • Parameters

    • aIndex: number

    Returns string

getDouble

  • Parameters

    • aIndex: number

    Returns number

getInt32

  • Obtain a value for the given entry (column) index. Due to SQLite's type conversion rules, any of these are valid for any column regardless of the column's data type. However, if the specific type matters, getTypeOfIndex should be used first to identify the column type, and then the appropriate get method should be called.

    If you ask for a string value for a NULL column, you will get an empty string with IsVoid set to distinguish it from an explicitly set empty string.

    Parameters

    • aIndex: number

    Returns number

getInt64

  • Parameters

    • aIndex: number

    Returns number

getIsNull

  • Parameters

    • aIndex: number

    Returns boolean

getSharedBlob

  • Parameters

    • aIndex: number
    • aByteLength: number
    • aResult: octetPtr

    Returns void

getSharedString

  • Parameters

    • aIndex: number
    • aByteLength: number
    • aResult: wstring

    Returns void

getSharedUTF8String

  • Returns a shared string pointer.

    Parameters

    • aIndex: number

      0-based colummn index.

    • aByteLength: number

      The number of bytes in the string or blob. This is the same as the number of characters for UTF-8 strings, and twice the number of characters for UTF-16 strings.

    • aResult: string

      A pointer to the string or blob.

    Returns void

getString

  • Parameters

    • aIndex: number

    Returns string

getTypeOfIndex

  • Returns the type of the value at the given column index; one of VALUE_TYPE_NULL, VALUE_TYPE_INTEGER, VALUE_TYPE_FLOAT, VALUE_TYPE_TEXT, VALUE_TYPE_BLOB.

    Parameters

    • aIndex: number

    Returns number

getUTF8String

  • Parameters

    • aIndex: number

    Returns string

Settings

Member Visibility

Theme

Generated using TypeDoc