CPLODBCSession Class Reference

#include <cpl_odbc.h>

Public Member Functions
	CPLODBCSession ()
	~CPLODBCSession ()
int	EstablishSession (const char *pszDSN, const char *pszUserid, const char *pszPassword)
const char *	GetLastError ()
int	ClearTransaction ()
int	BeginTransaction ()
int	CommitTransaction ()
int	RollbackTransaction ()
int	IsInTransaction ()
int	CloseSession ()
int	Failed (int, HSTMT=nullptr)
HDBC	GetConnection ()
HENV	GetEnvironment ()

Detailed Description

A class representing an ODBC database session.

Includes error collection services.

Constructor & Destructor Documentation

CPLODBCSession()

CPLODBCSession::CPLODBCSession

(

)

Constructor

~CPLODBCSession()

CPLODBCSession::~CPLODBCSession

(

)

Destructor

Member Function Documentation

BeginTransaction()

int CPLODBCSession::BeginTransaction

(

)

Begin transaction

ClearTransaction()

int CPLODBCSession::ClearTransaction

(

)

Clear transaction

CloseSession()

int CPLODBCSession::CloseSession

(

)

Close session

CommitTransaction()

int CPLODBCSession::CommitTransaction

(

)

Commit transaction

EstablishSession()

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

Connect to database and logon.

Parameters

pszDSN	The name of the DSN being used to connect. This is not optional.
pszUserid	the userid to logon as, may be NULL if not not required, or provided by the DSN.
pszPassword	the 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.

Failed()

int CPLODBCSession::Failed	(	int	nRetCode,
		HSTMT	hStmt = nullptr
	)

Test if a return code indicates failure, return TRUE if that is the case. Also update error text.

ODBC error messages are reported in the following format: [SQLState]ErrorMessage(NativeErrorCode)

Multiple error messages are delimeted by ",".

GetConnection()

HDBC CPLODBCSession::GetConnection ( )

inline

Return connection handle

GetEnvironment()

HENV CPLODBCSession::GetEnvironment ( )

inline

Return GetEnvironment handle

GetLastError()

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.

IsInTransaction()

int CPLODBCSession::IsInTransaction ( )

inline

Returns whether a transaction is active

RollbackTransaction()

int CPLODBCSession::RollbackTransaction

(

)

Rollback transaction

---

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

• cpl_odbc.h
• cpl_odbc.cpp