iopc::Parameter Class Reference
[iopcdb]

A parameter that cen be passed to a cursor. More...

#include <cursor.h>

Inheritance diagram for iopc::Parameter:

Inheritance graph
[legend]

List of all members.

Public Types

enum  ParamType { IN = 0, OUT }
 Parameter direction. More...

Public Member Functions

 Parameter (ParamType type, const int pos, const Type &varType, const MetadataHolder &attributes=MetadataHolder::emptyMeta, bool setNull=false)
void preExec (Cursor *cur)
 Notifies the parameter before Cursor::execute() is invoked.
void postExec (Cursor *cur)
 Notifies the parameter after Cursor::execute() call.
void preFetch (Cursor *cur)
 Notifies the parameter before first Cursor::fetchNext() after Cursor::execute() is invoked.
void postFetch (Cursor *cur)
 Notifies the parameter after each Cursor::fetchNext() call.
bool isNullValue ()
 Determines if the last fetched value was database NULL.


Detailed Description

A parameter that cen be passed to a cursor.

Author:
Petr Cermak

Member Enumeration Documentation

Parameter direction.

Enumerator:
IN  IN parameter.

Its implementations are notified with the preExec and postExec event methods

OUT  OUT parameter.

Its implementations are notified with the preFetch and postFetch event methods


Constructor & Destructor Documentation

iopc::Parameter::Parameter ( ParamType  type,
const int  pos,
const Type varType,
const MetadataHolder attributes = MetadataHolder::emptyMeta,
bool  setNull = false 
)

Parameters:
type Parameter direction
pos Position of the parameter in the prepared statement or in the result set
varType Parameter data type
attributes Additional attributes or driver-dependent data
setNull Determines whether this parameter should be set to database NULL (for IN parameters)


The documentation for this class was generated from the following files:

Generated on Tue Apr 14 16:46:38 2009 for IOPC 2 by  doxygen 1.5.6