SQLDBC::SQLDBC_Environment Class Reference

List of all members.

---

Detailed Description

The SQLDBC_Environment object is the basis for initializing the SQLDBC runtime library and making general settings in the SQLDBC interface.

Definition at line 3913 of file SQLDBC.h.

Public Member Functions

• SQLDBC_Environment (SQLDBC_IRuntime *runtime)

  Creates a new SQLDBC_Environment, using the provided interface to the runtime environment.
  

• ~SQLDBC_Environment ()

  The destructor.
  

• SQLDBC_Connection * createConnection () const

  Creates a new SQLDBC_Connection object.
  

• SQLDBC_Connection * createConnection (SAPDBMem_IRawAllocator &allocator) const

  Creates a new SQLDBC_Connection object.
  

• void releaseConnection (SQLDBC_Connection *connection) const

  Closes a SQLDBC_Connection.
  

• const char * getLibraryVersion ()

  Returns the version of used SQLDBC runtime.
  

• const char * getSDKVersion () const

  Returns the version of the used SQLDBC API.
  

• SAPDBMem_IRawAllocator & getAllocator ()

  Requests the allocator associated to this connection item.
  

• void setTraceOptions (const SQLDBC_ConnectProperties &traceoptions)

  Sets tracing options.
  

• void getTraceOptions (SQLDBC_ConnectProperties &traceoptions)

  Retrieves the current tracing options.
  

• SQLDBC_Profile * getProfile ()

  Get the profile.
  

---

Constructor & Destructor Documentation

SQLDBC::SQLDBC_Environment::SQLDBC_Environment (  SQLDBC_IRuntime *  runtime  )

Creates a new SQLDBC_Environment, using the provided interface to the runtime environment. Parameters: runtime  The runtime to be used, must not be 0. Implement the interface using SQLDBC_IRuntime or use the SQLDBC::GetClientRuntime() in a client application to obtain a valid argument for this constructor.

SQLDBC::SQLDBC_Environment::~SQLDBC_Environment (   )

The destructor.

---

Member Function Documentation

SQLDBC_Connection* SQLDBC::SQLDBC_Environment::createConnection (  SAPDBMem_IRawAllocator &  allocator  )  const

Creates a new SQLDBC_Connection object. Returns: A reference to a SQLDBC_Connection object. See also: releaseConnection

SQLDBC_Connection* SQLDBC::SQLDBC_Environment::createConnection (   )  const

Creates a new SQLDBC_Connection object. Returns: A reference to a SQLDBC_Connection object. See also: releaseConnection

SAPDBMem_IRawAllocator& SQLDBC::SQLDBC_Environment::getAllocator (   )

Requests the allocator associated to this connection item.

const char* SQLDBC::SQLDBC_Environment::getLibraryVersion (   )

Returns the version of used SQLDBC runtime. This is the version of the used SQLDBC library. The version of the loaded runtime may differ from the version inidacted in the used header. It is our aim that newer versions of the runtime will run with old applications without the need to be re-compiling. Returns: A character string in the format 'libSQLDBC M.M.C Build 002-000-000-000' containing a complete version string of the (shared) linked SQLDBC library.

SQLDBC_Profile* SQLDBC::SQLDBC_Environment::getProfile (   )

Get the profile. return the profile.

const char* SQLDBC::SQLDBC_Environment::getSDKVersion (   )  const [inline]

Returns the version of the used SQLDBC API. It corresponds to the version indicated in the used SQLDBC header. Returns: A character string of the format 'SQLDBC.H M.M.C Build 002-000-000-000' containing a complete version string. Definition at line 3982 of file SQLDBC.h.

void SQLDBC::SQLDBC_Environment::getTraceOptions (  SQLDBC_ConnectProperties &  traceoptions  )

Retrieves the current tracing options. Parameters: traceoptions  The options to be set in the trace. See setTraceOptions for a descriptions of the supported trace options.

void SQLDBC::SQLDBC_Environment::releaseConnection (  SQLDBC_Connection *  connection  )  const

Closes a SQLDBC_Connection. Parameters: connection  The SQLDBC_Connection to be closed. See also: createConnection

void SQLDBC::SQLDBC_Environment::setTraceOptions (  const SQLDBC_ConnectProperties &  traceoptions  )

Sets tracing options. Take care that the trace options may be set process-wide, not only for the this environment instance. Also, some options may be ignored if they are not applicable to the current runtime environment (e.g. setting the name of trace output file). Parameters: traceoptions  The options to be set in the trace. The following options are supported: Option> Data Type Description SQL BOOLEAN Enables SQL trace. SQL statements and data are logged. LONG BOOLEAN Enables long trace. Internal method calls with parameters are logged. SHORT BOOLEAN Enables short trace. Internal method calls are logged. PACKET BOOLEAN Enables packet trace. Incoming and outgoing packets are logged. TIMESTAMP BOOLEAN Precedes each trace output line with a current time stamp. FILESIZE NUMBER Set the maximum size of the trace file. If not supplied, the size FILENAME VARCHAR The trace file name. STOPONERROR BOOLEAN Whether tracing shall stop on when a specific error occurs (see also ERRORCODE and ERRORCOUNT). ERRORCODE NUMBER If STOPONERROR is set, the error code where the trace output stops. ERRORCOUNT NUMBER If STOPONERROR is set, number of times the error must occur before the trace stops. If not set, this defaults to 1.