GDAL
Public Member Functions | List of all members
CPLODBCSession Class Reference

A class representing an ODBC database session. More...

#include <cpl_odbc.h>

Public Member Functions

 CPLODBCSession ()
 Constructor.
 
 ~CPLODBCSession ()
 Destructor.
 
int EstablishSession (const char *pszDSN, const char *pszUserid, const char *pszPassword)
 Connect to database and logon. More...
 
const char * GetLastError ()
 Returns the last ODBC error message. More...
 
int ClearTransaction ()
 Clear transaction.
 
int BeginTransaction ()
 Begin transaction.
 
int CommitTransaction ()
 Commit transaction.
 
int RollbackTransaction ()
 Rollback transaction.
 
int IsInTransaction ()
 Returns whether a transaction is active.
 
int CloseSession ()
 Close session.
 
int Failed (int, HSTMT=NULL)
 Test if a return code indicates failure, return TRUE if that is the case. More...
 
HDBC GetConnection ()
 Return connection handle.
 
HENV GetEnvironment ()
 Return GetEnvironment handle.
 

Detailed Description

A class representing an ODBC database session.

Includes error collection services.

Member Function Documentation

int CPLODBCSession::EstablishSession ( const char *  pszDSN,
const char *  pszUserid,
const char *  pszPassword 
)

Connect to database and logon.

Parameters
pszDSNThe name of the DSN being used to connect. This is not optional.
pszUseridthe userid to logon as, may be NULL if not not required, or provided by the DSN.
pszPasswordthe password to logon with. May be NULL if not required or provided by the DSN.
Returns
TRUE on success or FALSE on failure. Call GetLastError() to get details on failure.
int CPLODBCSession::Failed ( int  nRetCode,
HSTMT  hStmt = NULL 
)

Test if a return code indicates failure, return TRUE if that is the case.

Also update error text.

const char * CPLODBCSession::GetLastError ( )

Returns the last ODBC error message.

Returns
pointer to an internal buffer with the error message in it. Do not free or alter. Will be an empty (but not NULL) string if there is no pending error info.

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

Generated for GDAL by doxygen 1.8.8.