SQLDBC.h File Reference

Detailed Description

General header file for the SAP Database Connectivity.

Author:: DL SAP DB INTERFACES

SQL Database Connectivity (SQLDBC) is a runtime library that enables applications to execute SQL statements in the database, and to access and modify data.

Definition in file SQLDBC.h.

Go to the source code of this file.

Namespaces

namespace SQLDBC

Classes

class SQLDBC::SQLDBC_ErrorHndl
Store for error messages and error codes. More...
class SQLDBC::SQLDBC_SQLWarning
A class for handling SQL warnings. More...
class SQLDBC::SQLDBC_ConnectionItem
Base class to administrate the error handling within SQLDBC. More...
class SQLDBC::SQLDBC_LOB
Interface to a large object (LOB). More...
class SQLDBC::SQLDBC_ParameterMetaData
Can retrieve information to find out the parameter types and their properties in a PreparedStatement object. More...
class SQLDBC::SQLDBC_ResultSetMetaData
A SQLDBC_ResultSetMetaData class can retrieve information used to find out types and properties of the columns in a ResultSet. More...
class SQLDBC::SQLDBC_RowSet
An SQLDBC_RowSet class for representing a SQLDBC row set. More...
class SQLDBC::SQLDBC_UpdatableRowSet
A SQLDBC_UpdatableRowSet class for representing a SQLDBC updatable row set. More...
class SQLDBC::SQLDBC_ResultSet
A class for presenting a database result set. More...
class SQLDBC::SQLDBC_Statement
An SQLDBC_Statement is a class for executing SQL statements immediately. More...
class SQLDBC::SQLDBC_PreparedStatement
A class for preparing and executing SQL statements. More...
class SQLDBC::SQLDBC_ConnectProperties
Specification of connection options. More...
class SQLDBC::SQLDBC_Connection
Connection to the database kernel. More...
class SQLDBC::SQLDBC_Profile
The SQLDBC_Profile object collects profile values of SQLDBC. More...
class SQLDBC::SQLDBC_Environment
The SQLDBC_Environment object is the basis for initializing the SQLDBC runtime library and making general settings in the SQLDBC interface. More...

Defines

#define SQLDBC_FEATURE_TRACEOPTION
If this macro is set the functions setTraceOption and getTraceOption from SQLDBCs debug trace facility are available.
#define SQLDBC_FEATURE_PROFILE
If this macro is set the Class SQLDBC_Profile is available.
#define SQLDBC_FEATURE_RESULTSET_ROWWISE
If this macro is set the Class SQLDBC_Profile is available.
#define SQLDBC_FEATURE_CONNECTION_FEATURES
If this macro is set the getConnectionFeatures method of SQLDBC_Connection is available.
#define SQLDBC_FEATURE_STATEMENT_GETCONNECTION
#define SQLDBC_FEATURE_METADATA_SCHEMATABLE
If this macro is set it is possible to retrieve the name of a table and a schema of a column in the result set metadata.
#define SQLDBC_FEATURE_METADATA_COLUMNLABEL
If this macro is set it is possible to retrieve the name of a table and a schema of a column in the result set metadata.
#define SQLDBC_FEATURE_LOB_KEEPALIVE
If this macro is set it is possible to hold lob descriptors open cursor borders.
#define SQLDBC_DLLEXPORT

Functions

SQLDBC_IRuntime * SQLDBC::GetClientRuntime (char *errorText, const SQLDBC_Int4 errorTextSize)
Returns a pointer to the client runtime instance.
SQLDBC_IRuntime * SQLDBC::GetSingleThreadClientRuntime (char *errorText, const SQLDBC_Int4 errorTextSize)
Returns a pointer to the single-threaded client runtime instance.

Variables

static const char *const SQLDBCHeaderVersion = "SQLDBC.H 7.7.4 BUILD 008-000-000-000"
The version string for the SQLDBC.H file.

Define Documentation

#define SQLDBC_DLLEXPORT

Definition at line 206 of file SQLDBC.h.

#define SQLDBC_FEATURE_CONNECTION_FEATURES

If this macro is set the getConnectionFeatures method of SQLDBC_Connection is available.
Set SQLDBC_CONNECTION_FEATURES_OFF to disable this functionality.
Note:
This feature is available since version 7.6.04.04 of SQLDBC

Definition at line 100 of file SQLDBC.h.

#define SQLDBC_FEATURE_LOB_KEEPALIVE

If this macro is set it is possible to hold lob descriptors open cursor borders.

Definition at line 138 of file SQLDBC.h.

#define SQLDBC_FEATURE_METADATA_COLUMNLABEL

If this macro is set it is possible to retrieve the name of a table and a schema of a column in the result set metadata.

Definition at line 129 of file SQLDBC.h.

#define SQLDBC_FEATURE_METADATA_SCHEMATABLE

If this macro is set it is possible to retrieve the name of a table and a schema of a column in the result set metadata.

Definition at line 119 of file SQLDBC.h.

#define SQLDBC_FEATURE_PROFILE

If this macro is set the Class SQLDBC_Profile is available.
Set SQLDBC_FEATURE_PROFILE_OFF to disable the profile functionality.
Note:
This feature is available since version 7.6.0.14 of SQLDBC

Definition at line 50 of file SQLDBC.h.

#define SQLDBC_FEATURE_RESULTSET_ROWWISE

If this macro is set the Class SQLDBC_Profile is available.
Set SQLDBC_FEATURE_RESULTSET_ROWWISE to disable the profile functionality.
Note:
This feature is available since version 7.6.0.14 of SQLDBC

Definition at line 88 of file SQLDBC.h.

#define SQLDBC_FEATURE_STATEMENT_GETCONNECTION

Definition at line 109 of file SQLDBC.h.

#define SQLDBC_FEATURE_TRACEOPTION

If this macro is set the functions setTraceOption and getTraceOption from SQLDBCs debug trace facility are available.
Set SQLDBC_FEATURE_TRACEOPTION_OFF to disable the trace functionality.
Note:
This feature is available since version 7.6.0.07 of SQLDBC

Definition at line 39 of file SQLDBC.h.

Variable Documentation

const char* const SQLDBCHeaderVersion = "SQLDBC.H 7.7.4 BUILD 008-000-000-000" [static]

The version string for the SQLDBC.H file.

Definition at line 180 of file SQLDBC.h.