Back to index

lightning-sunbird  0.9+nobinonly
Public Member Functions | Public Attributes
mozIStorageValueArray Interface Reference

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

import "mozIStorageValueArray.idl";

Inheritance diagram for mozIStorageValueArray:
Inheritance graph
[legend]
Collaboration diagram for mozIStorageValueArray:
Collaboration graph
[legend]

List of all members.

Public Member Functions

long getTypeOfIndex (in unsigned long aIndex)
 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.
long getInt32 (in unsigned long aIndex)
 Obtain a value for the given entry (column) index.
long long getInt64 (in unsigned long aIndex)
double getDouble (in unsigned long aIndex)
AUTF8String getUTF8String (in unsigned long aIndex)
AString getString (in unsigned long aIndex)
void getBlob (in unsigned long aIndex, out unsigned long aDataSize,[array, size_is(aDataSize)] out octet aData)
boolean getIsNull (in unsigned long aIndex)
void getSharedUTF8String (in unsigned long aIndex, out unsigned long aLength,[shared, retval] out string aResult)
 Returns a shared string pointer.
void getSharedString (in unsigned long aIndex, out unsigned long aLength,[shared, retval] out wstring aResult)
void getSharedBlob (in unsigned long aIndex, out unsigned long aLength,[shared, retval] out octetPtr aResult)
PRInt32 AsInt32 (PRUint32 idx)
 Getters for native code that return their values as the return type, for convenience and sanity.
PRInt64 AsInt64 (PRUint32 idx)
double AsDouble (PRUint32 idx)
const char * AsSharedUTF8String (PRUint32 idx, PRUint32 *len)
const PRUnicharAsSharedWString (PRUint32 idx, PRUint32 *len)
const PRUint8AsSharedBlob (PRUint32 idx, PRUint32 *len)
PRBool IsNull (PRUint32 idx)

Public Attributes

const long VALUE_TYPE_NULL = 0
 These type values are returned by getTypeOfIndex to indicate what type of value is present at a given column.
const long VALUE_TYPE_INTEGER = 1
const long VALUE_TYPE_FLOAT = 2
const long VALUE_TYPE_TEXT = 3
const long VALUE_TYPE_BLOB = 4
readonly attribute unsigned long numEntries
 numEntries

Detailed Description

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

Definition at line 48 of file mozIStorageValueArray.idl.


Member Function Documentation

double mozIStorageValueArray::AsDouble ( PRUint32  idx) [inline]

Definition at line 124 of file mozIStorageValueArray.idl.

                                       {
    double v;
    GetDouble(idx, &v);
    return v;
  }

Getters for native code that return their values as the return type, for convenience and sanity.

Not virtual; no vtable bloat.

Definition at line 112 of file mozIStorageValueArray.idl.

                                       {
    PRInt32 v;
    GetInt32(idx, &v);
    return v;
  }

Here is the caller graph for this function:

Definition at line 118 of file mozIStorageValueArray.idl.

                                       {
    PRInt64 v;
    GetInt64(idx, &v);
    return v;
  }

Definition at line 142 of file mozIStorageValueArray.idl.

                                                                  {
    const PRUint8 *blob = nsnull;
    GetSharedBlob(idx, len, &blob);
    return blob;
  }

Definition at line 130 of file mozIStorageValueArray.idl.

                                                                     {
    const char *str = nsnull;
    GetSharedUTF8String(idx, len, &str);
    return str;
  }

Definition at line 136 of file mozIStorageValueArray.idl.

                                                                       {
    const PRUnichar *str = nsnull;
    GetSharedString(idx, len, &str);
    return str;
  }
void mozIStorageValueArray::getBlob ( in unsigned long  aIndex,
out unsigned long  aDataSize,
[array, size_is(aDataSize)] out octet  aData 
)
double mozIStorageValueArray::getDouble ( in unsigned long  aIndex)

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.

void mozIStorageValueArray::getSharedBlob ( in unsigned long  aIndex,
out unsigned long  aLength,
[shared, retval] out octetPtr  aResult 
)
void mozIStorageValueArray::getSharedString ( in unsigned long  aIndex,
out unsigned long  aLength,
[shared, retval] out wstring  aResult 
)
void mozIStorageValueArray::getSharedUTF8String ( in unsigned long  aIndex,
out unsigned long  aLength,
[shared, retval] out string  aResult 
)

Returns a shared string pointer.

AString mozIStorageValueArray::getString ( in unsigned long  aIndex)

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.

AUTF8String mozIStorageValueArray::getUTF8String ( in unsigned long  aIndex)

Definition at line 148 of file mozIStorageValueArray.idl.

                                     {
    PRBool b = PR_FALSE;
    GetIsNull(idx, &b);
    return b;
  }

Member Data Documentation

numEntries

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

Definition at line 66 of file mozIStorageValueArray.idl.

Definition at line 58 of file mozIStorageValueArray.idl.

Definition at line 56 of file mozIStorageValueArray.idl.

Definition at line 55 of file mozIStorageValueArray.idl.

These type values are returned by getTypeOfIndex to indicate what type of value is present at a given column.

Definition at line 54 of file mozIStorageValueArray.idl.

Definition at line 57 of file mozIStorageValueArray.idl.


The documentation for this interface was generated from the following file: