odbc::CallableStatement Class Reference

Inheritance diagram for odbc::CallableStatement:

odbc::PreparedStatement odbc::PreparedStatement odbc::Statement odbc::Statement odbc::Statement odbc::Statement odbc::ErrorHandler odbc::ErrorHandler odbc::ErrorHandler odbc::ErrorHandler odbc::ErrorHandler odbc::ErrorHandler odbc::ErrorHandler odbc::ErrorHandler List of all members.

Detailed Description

A prepared statement suited for stored procedure calls.

A CallableStatement extends the functionality of a PreparedStatement, by allowing output parameters.

The ODBC escapes for calling stored procedures and functions should be used. A procedure call is prepared like this:

 std::auto_ptr<CallableStatement> cstmt
    =stdauto_ptr<CallableStatement>(con->prepareCall
     ("{call my_procedure(?,?,?)}"));
 

And for a function call (a procedure that returns a value), the following syntax should be used:

 std::auto_ptr<CallableStatement> cstmt
    =stdauto_ptr<CallableStatement>(con->prepareCall
     ("{?=call my_function(?,?)}"));
 

All parameters in a CallableStatement are treated as input/output parameters, unless they are registered as output-only parameters with registerOutParameter(). Note that output-only parameters must be registered with their proper SQL type prior to executing a CallableStatement.

Definition at line 59 of file callablestatement.h.

Public Member Functions

bool getBoolean (int idx)
 Fetches a parameter as a bool.
bool getBoolean (int idx)
 Fetches a parameter as a bool.
signed char getByte (int idx)
 Fetches a parameter as a signed char.
signed char getByte (int idx)
 Fetches a parameter as a signed char.
ODBCXX_BYTES getBytes (int idx)
 Fetches a parameter as a Bytes object.
ODBCXX_BYTES getBytes (int idx)
 Fetches a parameter as a Bytes object.
Date getDate (int idx)
 Fetches a parameter as a Date.
Date getDate (int idx)
 Fetches a parameter as a Date.
double getDouble (int idx)
 Fetches a parameter as a double.
double getDouble (int idx)
 Fetches a parameter as a double.
float getFloat (int idx)
 Fetches a parameter as a float.
float getFloat (int idx)
 Fetches a parameter as a float.
int getInt (int idx)
 Fetches a parameter as an int.
int getInt (int idx)
 Fetches a parameter as an int.
Long getLong (int idx)
 Fetches a parameter as a Long.
Long getLong (int idx)
 Fetches a parameter as a Long.
short getShort (int idx)
 Fetches a parameter as a short.
short getShort (int idx)
 Fetches a parameter as a short.
ODBCXX_STRING getString (int idx)
 Fetches a parameter as a string.
ODBCXX_STRING getString (int idx)
 Fetches a parameter as a string.
Time getTime (int idx)
 Fetches a parameter as a Time.
Time getTime (int idx)
 Fetches a parameter as a Time.
Timestamp getTimestamp (int idx)
 Fetches a parameter as a Timestamp.
Timestamp getTimestamp (int idx)
 Fetches a parameter as a Timestamp.
void registerInParameter (int idx)
 Registers an input only parameter.
void registerInParameter (int idx)
 Registers an input only parameter.
void registerOutParameter (int idx, int sqlType, int scale)
 Registers an output parameter with a given scale.
void registerOutParameter (int idx, int sqlType)
 Registers an output parameter.
void registerOutParameter (int idx, int sqlType, int scale)
 Registers an output parameter with a given scale.
void registerOutParameter (int idx, int sqlType)
 Registers an output parameter.
bool wasNull ()
 Returns true if the last fetched parameter was NULL.
bool wasNull ()
 Returns true if the last fetched parameter was NULL.
virtual ~CallableStatement ()
 Destructor.
virtual ~CallableStatement ()
 Destructor.


Member Function Documentation

bool odbc::CallableStatement::getBoolean ( int  idx  ) 

Fetches a parameter as a bool.

Parameters:
idx The parameter index, starting at 1

bool odbc::CallableStatement::getBoolean ( int  idx  ) 

Fetches a parameter as a bool.

Parameters:
idx The parameter index, starting at 1

signed char odbc::CallableStatement::getByte ( int  idx  ) 

Fetches a parameter as a signed char.

Parameters:
idx The parameter index, starting at 1

signed char odbc::CallableStatement::getByte ( int  idx  ) 

Fetches a parameter as a signed char.

Parameters:
idx The parameter index, starting at 1

ODBCXX_BYTES odbc::CallableStatement::getBytes ( int  idx  ) 

Fetches a parameter as a Bytes object.

Parameters:
idx The parameter index, starting at 1

ODBCXX_BYTES odbc::CallableStatement::getBytes ( int  idx  ) 

Fetches a parameter as a Bytes object.

Parameters:
idx The parameter index, starting at 1

Date odbc::CallableStatement::getDate ( int  idx  ) 

Fetches a parameter as a Date.

Parameters:
idx The parameter index, starting at 1

Date odbc::CallableStatement::getDate ( int  idx  ) 

Fetches a parameter as a Date.

Parameters:
idx The parameter index, starting at 1

double odbc::CallableStatement::getDouble ( int  idx  ) 

Fetches a parameter as a double.

Parameters:
idx The parameter index, starting at 1

double odbc::CallableStatement::getDouble ( int  idx  ) 

Fetches a parameter as a double.

Parameters:
idx The parameter index, starting at 1

float odbc::CallableStatement::getFloat ( int  idx  ) 

Fetches a parameter as a float.

Parameters:
idx The parameter index, starting at 1

float odbc::CallableStatement::getFloat ( int  idx  ) 

Fetches a parameter as a float.

Parameters:
idx The parameter index, starting at 1

int odbc::CallableStatement::getInt ( int  idx  ) 

Fetches a parameter as an int.

Parameters:
idx The parameter index, starting at 1

int odbc::CallableStatement::getInt ( int  idx  ) 

Fetches a parameter as an int.

Parameters:
idx The parameter index, starting at 1

Long odbc::CallableStatement::getLong ( int  idx  ) 

Fetches a parameter as a Long.

Parameters:
idx The parameter index, starting at 1

Long odbc::CallableStatement::getLong ( int  idx  ) 

Fetches a parameter as a Long.

Parameters:
idx The parameter index, starting at 1

short odbc::CallableStatement::getShort ( int  idx  ) 

Fetches a parameter as a short.

Parameters:
idx The parameter index, starting at 1

short odbc::CallableStatement::getShort ( int  idx  ) 

Fetches a parameter as a short.

Parameters:
idx The parameter index, starting at 1

ODBCXX_STRING odbc::CallableStatement::getString ( int  idx  ) 

Fetches a parameter as a string.

Parameters:
idx The parameter index, starting at 1

ODBCXX_STRING odbc::CallableStatement::getString ( int  idx  ) 

Fetches a parameter as a string.

Parameters:
idx The parameter index, starting at 1

Time odbc::CallableStatement::getTime ( int  idx  ) 

Fetches a parameter as a Time.

Parameters:
idx The parameter index, starting at 1

Time odbc::CallableStatement::getTime ( int  idx  ) 

Fetches a parameter as a Time.

Parameters:
idx The parameter index, starting at 1

Timestamp odbc::CallableStatement::getTimestamp ( int  idx  ) 

Fetches a parameter as a Timestamp.

Parameters:
idx The parameter index, starting at 1

Timestamp odbc::CallableStatement::getTimestamp ( int  idx  ) 

Fetches a parameter as a Timestamp.

Parameters:
idx The parameter index, starting at 1

void odbc::CallableStatement::registerInParameter ( int  idx  ) 

Registers an input only parameter.

Parameters:
idx The parameter index, starting at 1

void odbc::CallableStatement::registerInParameter ( int  idx  ) 

Registers an input only parameter.

Parameters:
idx The parameter index, starting at 1

void odbc::CallableStatement::registerOutParameter ( int  idx,
int  sqlType,
int  scale 
)

Registers an output parameter with a given scale.

Parameters:
idx The parameter index, starting at 1
sqlType The SQL type of the parameter
scale The scale of the parameter.
See also:
Types

void odbc::CallableStatement::registerOutParameter ( int  idx,
int  sqlType 
) [inline]

Registers an output parameter.

Parameters:
idx The parameter index, starting at 1
sqlType The SQL type of the parameter
See also:
Types

Definition at line 141 of file callablestatement.h.

void odbc::CallableStatement::registerOutParameter ( int  idx,
int  sqlType,
int  scale 
)

Registers an output parameter with a given scale.

Parameters:
idx The parameter index, starting at 1
sqlType The SQL type of the parameter
scale The scale of the parameter.
See also:
Types

void odbc::CallableStatement::registerOutParameter ( int  idx,
int  sqlType 
) [inline]

Registers an output parameter.

Parameters:
idx The parameter index, starting at 1
sqlType The SQL type of the parameter
See also:
Types

Definition at line 141 of file callablestatement.h.


The documentation for this class was generated from the following files:
GridLAB-DTM Version 1.0
An open-source project initiated by the US Department of Energy