odbc::CallableStatement Class Reference

A prepared statement suited for stored procedure calls. More...

#include <callablestatement.h>

Inheritance diagram for odbc::CallableStatement:

List of all members.

Public Member Functions

virtual ~CallableStatement ()
Destructor.
double getDouble (int idx)
Fetches a parameter as a double.
bool getBoolean (int idx)
Fetches a parameter as a bool.
signed char getByte (int idx)
Fetches a parameter as a signed char.
Bytes getBytes (int idx)
Fetches a parameter as a Bytes object.
Date getDate (int idx)
Fetches a parameter as a Date.
float getFloat (int idx)
Fetches a parameter as a float.
int getInt (int idx)
Fetches a parameter as an int.
Long getLong (int idx)
Fetches a parameter as a Long.
short getShort (int idx)
Fetches a parameter as a short.
std::string getString (int idx)
Fetches a parameter as a string.
Time getTime (int idx)
Fetches a parameter as a Time.
Timestamp getTimestamp (int idx)
Fetches a parameter as a Timestamp.
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 registerInParameter (int idx)
Registers an input only parameter.
bool wasNull ()
Returns true if the last fetched parameter was NULL.

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.

Member Function Documentation

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

Fetches a parameter as a bool.

Parameters:

idx