EVOLUTION-MANAGER
Edit File: classCPLODBCSession.html
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"> <html xmlns="http://www.w3.org/1999/xhtml"> <head> <meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/> <meta http-equiv="X-UA-Compatible" content="IE=9"/> <meta name="generator" content="Doxygen 1.8.5"/> <title>SDTS_AL: CPLODBCSession Class Reference</title> <link href="tabs.css" rel="stylesheet" type="text/css"/> <script type="text/javascript" src="jquery.js"></script> <script type="text/javascript" src="dynsections.js"></script> <link href="doxygen.css" rel="stylesheet" type="text/css" /> </head> <body> <div id="top"><!-- do not remove this div, it is closed by doxygen! --> <div id="titlearea"> <table cellspacing="0" cellpadding="0"> <tbody> <tr style="height: 56px;"> <td style="padding-left: 0.5em;"> <div id="projectname">SDTS_AL </div> </td> </tr> </tbody> </table> </div> <!-- end header part --> <!-- Generated by Doxygen 1.8.5 --> <div id="navrow1" class="tabs"> <ul class="tablist"> <li><a href="index.html"><span>Main Page</span></a></li> <li><a href="pages.html"><span>Related Pages</span></a></li> <li class="current"><a href="annotated.html"><span>Classes</span></a></li> <li><a href="files.html"><span>Files</span></a></li> </ul> </div> <div id="navrow2" class="tabs2"> <ul class="tablist"> <li><a href="annotated.html"><span>Class List</span></a></li> <li><a href="classes.html"><span>Class Index</span></a></li> <li><a href="hierarchy.html"><span>Class Hierarchy</span></a></li> <li><a href="functions.html"><span>Class Members</span></a></li> </ul> </div> </div><!-- top --> <div class="header"> <div class="summary"> <a href="#pub-methods">Public Member Functions</a> | <a href="classCPLODBCSession-members.html">List of all members</a> </div> <div class="headertitle"> <div class="title">CPLODBCSession Class Reference</div> </div> </div><!--header--> <div class="contents"> <p><code>#include <<a class="el" href="cpl__odbc_8h_source.html">cpl_odbc.h</a>></code></p> <table class="memberdecls"> <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a> Public Member Functions</h2></td></tr> <tr class="memitem:ae720f606a1cdbe412a009e17dc51d39d"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classCPLODBCSession.html#ae720f606a1cdbe412a009e17dc51d39d">CPLODBCSession</a> ()</td></tr> <tr class="separator:ae720f606a1cdbe412a009e17dc51d39d"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:ac802962a10b2677e3321bb241d7d8baa"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classCPLODBCSession.html#ac802962a10b2677e3321bb241d7d8baa">~CPLODBCSession</a> ()</td></tr> <tr class="separator:ac802962a10b2677e3321bb241d7d8baa"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:aa25f8f6b0370dafc0e1fb3435388fdef"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="classCPLODBCSession.html#aa25f8f6b0370dafc0e1fb3435388fdef">EstablishSession</a> (const char *pszDSN, const char *pszUserid, const char *pszPassword)</td></tr> <tr class="separator:aa25f8f6b0370dafc0e1fb3435388fdef"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:a3a7f6353e992d35569c6a963c40a0cbb"><td class="memItemLeft" align="right" valign="top">const char * </td><td class="memItemRight" valign="bottom"><a class="el" href="classCPLODBCSession.html#a3a7f6353e992d35569c6a963c40a0cbb">GetLastError</a> ()</td></tr> <tr class="separator:a3a7f6353e992d35569c6a963c40a0cbb"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:aa2eb7cf0a477cf12d9fb72d61d244dca"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="classCPLODBCSession.html#aa2eb7cf0a477cf12d9fb72d61d244dca">ClearTransaction</a> ()</td></tr> <tr class="separator:aa2eb7cf0a477cf12d9fb72d61d244dca"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:ae9246dd84aa8d0362bff1bde049d722f"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="classCPLODBCSession.html#ae9246dd84aa8d0362bff1bde049d722f">BeginTransaction</a> ()</td></tr> <tr class="separator:ae9246dd84aa8d0362bff1bde049d722f"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:af581a96ecb2ceb24c573fca164ac6396"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="classCPLODBCSession.html#af581a96ecb2ceb24c573fca164ac6396">CommitTransaction</a> ()</td></tr> <tr class="separator:af581a96ecb2ceb24c573fca164ac6396"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:ad9550aa9d5faad39110d7d273d792b26"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="classCPLODBCSession.html#ad9550aa9d5faad39110d7d273d792b26">RollbackTransaction</a> ()</td></tr> <tr class="separator:ad9550aa9d5faad39110d7d273d792b26"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:a0ec277504d4393bbc92a2fc0d4a6a15b"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="classCPLODBCSession.html#a0ec277504d4393bbc92a2fc0d4a6a15b">IsInTransaction</a> ()</td></tr> <tr class="separator:a0ec277504d4393bbc92a2fc0d4a6a15b"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:ad2e9a403fa56f1d9781ceceb5c494b31"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="classCPLODBCSession.html#ad2e9a403fa56f1d9781ceceb5c494b31">CloseSession</a> ()</td></tr> <tr class="separator:ad2e9a403fa56f1d9781ceceb5c494b31"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:a296fa1c306c95293cd1c7c8327317e81"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="classCPLODBCSession.html#a296fa1c306c95293cd1c7c8327317e81">Failed</a> (int, HSTMT=nullptr)</td></tr> <tr class="separator:a296fa1c306c95293cd1c7c8327317e81"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:a1e5be05aeee3152b5d08e9b9472ab157"><td class="memItemLeft" align="right" valign="top">HDBC </td><td class="memItemRight" valign="bottom"><a class="el" href="classCPLODBCSession.html#a1e5be05aeee3152b5d08e9b9472ab157">GetConnection</a> ()</td></tr> <tr class="separator:a1e5be05aeee3152b5d08e9b9472ab157"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:ad02872998f4a5ef8ae0d49a4c35e0996"><td class="memItemLeft" align="right" valign="top">HENV </td><td class="memItemRight" valign="bottom"><a class="el" href="classCPLODBCSession.html#ad02872998f4a5ef8ae0d49a4c35e0996">GetEnvironment</a> ()</td></tr> <tr class="separator:ad02872998f4a5ef8ae0d49a4c35e0996"><td class="memSeparator" colspan="2"> </td></tr> </table> <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2> <div class="textblock"><p>A class representing an ODBC database session.</p> <p>Includes error collection services. </p> </div><h2 class="groupheader">Constructor & Destructor Documentation</h2> <a class="anchor" id="ae720f606a1cdbe412a009e17dc51d39d"></a> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">CPLODBCSession::CPLODBCSession </td> <td>(</td> <td class="paramname"></td><td>)</td> <td></td> </tr> </table> </div><div class="memdoc"> <p>Constructor </p> </div> </div> <a class="anchor" id="ac802962a10b2677e3321bb241d7d8baa"></a> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">CPLODBCSession::~CPLODBCSession </td> <td>(</td> <td class="paramname"></td><td>)</td> <td></td> </tr> </table> </div><div class="memdoc"> <p>Destructor </p> </div> </div> <h2 class="groupheader">Member Function Documentation</h2> <a class="anchor" id="ae9246dd84aa8d0362bff1bde049d722f"></a> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">int CPLODBCSession::BeginTransaction </td> <td>(</td> <td class="paramname"></td><td>)</td> <td></td> </tr> </table> </div><div class="memdoc"> <p>Begin transaction </p> </div> </div> <a class="anchor" id="aa2eb7cf0a477cf12d9fb72d61d244dca"></a> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">int CPLODBCSession::ClearTransaction </td> <td>(</td> <td class="paramname"></td><td>)</td> <td></td> </tr> </table> </div><div class="memdoc"> <p>Clear transaction </p> </div> </div> <a class="anchor" id="ad2e9a403fa56f1d9781ceceb5c494b31"></a> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">int CPLODBCSession::CloseSession </td> <td>(</td> <td class="paramname"></td><td>)</td> <td></td> </tr> </table> </div><div class="memdoc"> <p>Close session </p> </div> </div> <a class="anchor" id="af581a96ecb2ceb24c573fca164ac6396"></a> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">int CPLODBCSession::CommitTransaction </td> <td>(</td> <td class="paramname"></td><td>)</td> <td></td> </tr> </table> </div><div class="memdoc"> <p>Commit transaction </p> </div> </div> <a class="anchor" id="aa25f8f6b0370dafc0e1fb3435388fdef"></a> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">int CPLODBCSession::EstablishSession </td> <td>(</td> <td class="paramtype">const char * </td> <td class="paramname"><em>pszDSN</em>, </td> </tr> <tr> <td class="paramkey"></td> <td></td> <td class="paramtype">const char * </td> <td class="paramname"><em>pszUserid</em>, </td> </tr> <tr> <td class="paramkey"></td> <td></td> <td class="paramtype">const char * </td> <td class="paramname"><em>pszPassword</em> </td> </tr> <tr> <td></td> <td>)</td> <td></td><td></td> </tr> </table> </div><div class="memdoc"> <p>Connect to database and logon.</p> <dl class="params"><dt>Parameters</dt><dd> <table class="params"> <tr><td class="paramname">pszDSN</td><td>The name of the DSN being used to connect. This is not optional.</td></tr> <tr><td class="paramname">pszUserid</td><td>the userid to logon as, may be NULL if not not required, or provided by the DSN.</td></tr> <tr><td class="paramname">pszPassword</td><td>the password to logon with. May be NULL if not required or provided by the DSN.</td></tr> </table> </dd> </dl> <dl class="section return"><dt>Returns</dt><dd>TRUE on success or FALSE on failure. Call <a class="el" href="classCPLODBCSession.html#a3a7f6353e992d35569c6a963c40a0cbb">GetLastError()</a> to get details on failure. </dd></dl> </div> </div> <a class="anchor" id="a296fa1c306c95293cd1c7c8327317e81"></a> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">int CPLODBCSession::Failed </td> <td>(</td> <td class="paramtype">int </td> <td class="paramname"><em>nRetCode</em>, </td> </tr> <tr> <td class="paramkey"></td> <td></td> <td class="paramtype">HSTMT </td> <td class="paramname"><em>hStmt</em> = <code>nullptr</code> </td> </tr> <tr> <td></td> <td>)</td> <td></td><td></td> </tr> </table> </div><div class="memdoc"> <p>Test if a return code indicates failure, return TRUE if that is the case. Also update error text. </p> </div> </div> <a class="anchor" id="a1e5be05aeee3152b5d08e9b9472ab157"></a> <div class="memitem"> <div class="memproto"> <table class="mlabels"> <tr> <td class="mlabels-left"> <table class="memname"> <tr> <td class="memname">HDBC CPLODBCSession::GetConnection </td> <td>(</td> <td class="paramname"></td><td>)</td> <td></td> </tr> </table> </td> <td class="mlabels-right"> <span class="mlabels"><span class="mlabel">inline</span></span> </td> </tr> </table> </div><div class="memdoc"> <p>Return connection handle </p> </div> </div> <a class="anchor" id="ad02872998f4a5ef8ae0d49a4c35e0996"></a> <div class="memitem"> <div class="memproto"> <table class="mlabels"> <tr> <td class="mlabels-left"> <table class="memname"> <tr> <td class="memname">HENV CPLODBCSession::GetEnvironment </td> <td>(</td> <td class="paramname"></td><td>)</td> <td></td> </tr> </table> </td> <td class="mlabels-right"> <span class="mlabels"><span class="mlabel">inline</span></span> </td> </tr> </table> </div><div class="memdoc"> <p>Return GetEnvironment handle </p> </div> </div> <a class="anchor" id="a3a7f6353e992d35569c6a963c40a0cbb"></a> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">const char * CPLODBCSession::GetLastError </td> <td>(</td> <td class="paramname"></td><td>)</td> <td></td> </tr> </table> </div><div class="memdoc"> <p>Returns the last ODBC error message.</p> <dl class="section return"><dt>Returns</dt><dd>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. </dd></dl> </div> </div> <a class="anchor" id="a0ec277504d4393bbc92a2fc0d4a6a15b"></a> <div class="memitem"> <div class="memproto"> <table class="mlabels"> <tr> <td class="mlabels-left"> <table class="memname"> <tr> <td class="memname">int CPLODBCSession::IsInTransaction </td> <td>(</td> <td class="paramname"></td><td>)</td> <td></td> </tr> </table> </td> <td class="mlabels-right"> <span class="mlabels"><span class="mlabel">inline</span></span> </td> </tr> </table> </div><div class="memdoc"> <p>Returns whether a transaction is active </p> </div> </div> <a class="anchor" id="ad9550aa9d5faad39110d7d273d792b26"></a> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">int CPLODBCSession::RollbackTransaction </td> <td>(</td> <td class="paramname"></td><td>)</td> <td></td> </tr> </table> </div><div class="memdoc"> <p>Rollback transaction </p> </div> </div> <hr/>The documentation for this class was generated from the following files:<ul> <li><a class="el" href="cpl__odbc_8h_source.html">cpl_odbc.h</a></li> <li>cpl_odbc.cpp</li> </ul> </div><!-- contents --> <!-- start footer part --> <hr class="footer"/><address class="footer"><small> Generated by  <a href="http://www.doxygen.org/index.html"> <img class="footer" src="doxygen.png" alt="doxygen"/> </a> 1.8.5 </small></address> </body> </html>