mozIStorageStatement Interface Reference

import "mozIStorageStatement.idl";

Inheritance diagram for mozIStorageStatement:

mozIStorageValueArray List of all members.

Public Member Functions

void initialize (in mozIStorageConnection aDBConnection, in AUTF8String aSQLStatement)
mozIStorageStatement clone ()
AUTF8String getParameterName (in unsigned long aParamIndex)
void getParameterIndexes (in AUTF8String aParameterName, out unsigned long aCount,[array, size_is(aCount), retval] out unsigned long aIndexes)
AUTF8String getColumnName (in unsigned long aColumnIndex)
void reset ()
void bindCStringParameter (in unsigned long aParamIndex, in string aValue)
void bindUTF8StringParameter (in unsigned long aParamIndex, in AUTF8String aValue)
void bindWStringParameter (in unsigned long aParamIndex, in wstring aValue)
void bindStringParameter (in unsigned long aParamIndex, in AString aValue)
void bindDoubleParameter (in unsigned long aParamIndex, in double aValue)
void bindInt32Parameter (in unsigned long aParamIndex, in long aValue)
void bindInt64Parameter (in unsigned long aParamIndex, in long long aValue)
void bindNullParameter (in unsigned long aParamIndex)
void bindDataParameter (in unsigned long aParamIndex,[array, const, size_is(aValueSize)] in octet aValue, in unsigned long aValueSize)
void execute ()
mozIStorageDataSet executeDataSet ()
boolean executeStep ()
sqlite3stmtptr getNativeStatementPointer ()

Public Attributes

readonly attribute unsigned
long 		parameterCount
readonly attribute unsigned
long 		columnCount
const long MOZ_STORAGE_STATEMENT_INVALID = 0
const long MOZ_STORAGE_STATEMENT_READY = 1
const long MOZ_STORAGE_STATEMENT_EXECUTING = 2
readonly attribute long state

Member Function Documentation

void mozIStorageStatement::bindCStringParameter (  in unsigned long  aParamIndex,
in string  aValue
) 
 

void mozIStorageStatement::bindDataParameter (  in unsigned long  aParamIndex,
[array, const, size_is(aValueSize)] in octet  aValue,
in unsigned long  aValueSize
) 
 

void mozIStorageStatement::bindDoubleParameter (  in unsigned long  aParamIndex,
in double  aValue
) 
 

void mozIStorageStatement::bindInt32Parameter (  in unsigned long  aParamIndex,
in long  aValue
) 
 

void mozIStorageStatement::bindInt64Parameter (  in unsigned long  aParamIndex,
in long long  aValue
) 
 

void mozIStorageStatement::bindNullParameter (  in unsigned long  aParamIndex  ) 
 

void mozIStorageStatement::bindStringParameter (  in unsigned long  aParamIndex,
in AString  aValue
) 
 

void mozIStorageStatement::bindUTF8StringParameter (  in unsigned long  aParamIndex,
in AUTF8String  aValue
) 
 

void mozIStorageStatement::bindWStringParameter (  in unsigned long  aParamIndex,
in wstring  aValue
) 
 

mozIStorageStatement mozIStorageStatement::clone (   ) 
 

void mozIStorageStatement::execute (   ) 
 

Execute the query, ignoring any results. This is accomplished by calling step() once, and then calling reset().

Error and last insert info, etc. are available from the mozStorageConnection.

mozIStorageDataSet mozIStorageStatement::executeDataSet (   ) 
 

Execute the query, using any currently-bound parameters.

Returns:
a mozIStorageDataSet containing all the rows of the query result.

boolean mozIStorageStatement::executeStep (   ) 
 

Execute a query, using any currently-bound parameters. Reset must be called on the statement after the last call of executeStep.

Returns:
a boolean indicating whether there are more rows or not; row data may be accessed using mozIStorageValueArray methods on the statement.

AUTF8String mozIStorageStatement::getColumnName (  in unsigned long  aColumnIndex  ) 
 

sqlite3stmtptr mozIStorageStatement::getNativeStatementPointer (   ) 
 

void mozIStorageStatement::getParameterIndexes (  in AUTF8String  aParameterName,
out unsigned long  aCount,
[array, size_is(aCount), retval] out unsigned long  aIndexes
) 
 

AUTF8String mozIStorageStatement::getParameterName (  in unsigned long  aParamIndex  ) 
 

void mozIStorageStatement::initialize (  in mozIStorageConnection  aDBConnection,
in AUTF8String  aSQLStatement
) 
 

Initialize this query with the given SQL statement.

void mozIStorageStatement::reset (   ) 
 

Member Data Documentation

readonly attribute unsigned long mozIStorageStatement::columnCount
 

const long mozIStorageStatement::MOZ_STORAGE_STATEMENT_EXECUTING = 2
 

const long mozIStorageStatement::MOZ_STORAGE_STATEMENT_INVALID = 0
 

The current state. Row getters are only valid while the statement is in the "executing" state.

const long mozIStorageStatement::MOZ_STORAGE_STATEMENT_READY = 1
 

readonly attribute unsigned long mozIStorageStatement::parameterCount
 

readonly attribute long mozIStorageStatement::state
 

The documentation for this interface was generated from the following file:
Generated on Sun Jan 29 09:41:52 2006 by  doxygen 1.4.5