| <!-- This comment will put IE 6, 7 and 8 in quirks mode --> |
| <!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"/> |
| <title>tmudr: tmudr::UDRException Class Reference</title> |
| <link href="tabs.css" rel="stylesheet" type="text/css"/> |
| <link href="search/search.css" rel="stylesheet" type="text/css"/> |
| <script type="text/javaScript" src="search/search.js"></script> |
| <link href="doxygen.css" rel="stylesheet" type="text/css"/> |
| </head> |
| <body onload='searchBox.OnSelectItem(0);'> |
| <!-- Generated by Doxygen 1.6.1 --> |
| <script type="text/javascript"><!-- |
| var searchBox = new SearchBox("searchBox", "search",false,'Search'); |
| --></script> |
| <div class="navigation" id="top"> |
| <div class="tabs"> |
| <ul> |
| <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>Data Structures</span></a></li> |
| <li><a href="files.html"><span>Files</span></a></li> |
| <li> |
| <div id="MSearchBox" class="MSearchBoxInactive"> |
| <img id="MSearchSelect" src="search/search.png" |
| onmouseover="return searchBox.OnSearchSelectShow()" |
| onmouseout="return searchBox.OnSearchSelectHide()" |
| alt=""/> |
| <input type="text" id="MSearchField" value="Search" accesskey="S" |
| onfocus="searchBox.OnSearchFieldFocus(true)" |
| onblur="searchBox.OnSearchFieldFocus(false)" |
| onkeyup="searchBox.OnSearchFieldChange(event)"/> |
| <a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a> |
| </div> |
| </li> |
| </ul> |
| </div> |
| <div class="tabs"> |
| <ul> |
| <li><a href="annotated.html"><span>Data Structures</span></a></li> |
| <li><a href="hierarchy.html"><span>Class Hierarchy</span></a></li> |
| <li><a href="functions.html"><span>Data Fields</span></a></li> |
| </ul> |
| </div> |
| <div class="navpath"><b>tmudr</b>::<a class="el" href="classtmudr_1_1UDRException.html">UDRException</a> |
| </div> |
| </div> |
| <div class="contents"> |
| <h1>tmudr::UDRException Class Reference</h1><!-- doxytag: class="tmudr::UDRException" --> |
| <p>This is the exception to throw when an error occurs in a <a class="el" href="classtmudr_1_1UDR.html" title="This class represents the code associated with a UDR.">UDR</a>. |
| <a href="#_details">More...</a></p> |
| |
| <p><code>#include <<a class="el" href="sqludr_8h_source.html">sqludr.h</a>></code></p> |
| <table border="0" cellpadding="0" cellspacing="0"> |
| <tr><td colspan="2"><h2>Public Member Functions</h2></td></tr> |
| <tr><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classtmudr_1_1UDRException.html#a4a0892baa3b4746b0310339a24a1219b">UDRException</a> (int sqlState, const char *printf_format,...)</td></tr> |
| <tr><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classtmudr_1_1UDRException.html#a1d565a22c7a46717c688de64ab56f755">UDRException</a> (const char *sqlState, const char *printf_format,...)</td></tr> |
| <tr><td class="memItemLeft" align="right" valign="top">const char * </td><td class="memItemRight" valign="bottom"><a class="el" href="classtmudr_1_1UDRException.html#ab72a1a01900f1cc7f0ac28cba5b2092d">getSQLState</a> () const </td></tr> |
| <tr><td class="memItemLeft" align="right" valign="top">const std::string & </td><td class="memItemRight" valign="bottom"><a class="el" href="classtmudr_1_1UDRException.html#aa9d80f9be4771b873ca0ef2044e63306">getMessage</a> () const </td></tr> |
| <tr><td class="memItemLeft" align="right" valign="top">const std::string & </td><td class="memItemRight" valign="bottom"><a class="el" href="classtmudr_1_1UDRException.html#a1fbcd51c04fd8253403bef5c7d5b0879">getText</a> () const </td></tr> |
| </table> |
| <hr/><a name="_details"></a><h2>Detailed Description</h2> |
| <p>This is the exception to throw when an error occurs in a <a class="el" href="classtmudr_1_1UDR.html" title="This class represents the code associated with a UDR.">UDR</a>. </p> |
| <p>The SQLState value must be a value between 38000 and 38999, since the SQL standard reserves SQLState class 38 for user-written code. SQLState values 38950 to 38999 are reserved for use by Trafodion code. Trafodion will produce SQL error code -11252 when this exception is thrown. </p> |
| <hr/><h2>Constructor & Destructor Documentation</h2> |
| <a class="anchor" id="a4a0892baa3b4746b0310339a24a1219b"></a><!-- doxytag: member="tmudr::UDRException::UDRException" ref="a4a0892baa3b4746b0310339a24a1219b" args="(int sqlState, const char *printf_format,...)" --> |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">UDRException::UDRException </td> |
| <td>(</td> |
| <td class="paramtype">int </td> |
| <td class="paramname"> <em>sqlState</em>, </td> |
| </tr> |
| <tr> |
| <td class="paramkey"></td> |
| <td></td> |
| <td class="paramtype">const char * </td> |
| <td class="paramname"> <em>printf_format</em>, </td> |
| </tr> |
| <tr> |
| <td class="paramkey"></td> |
| <td></td> |
| <td class="paramtype"> </td> |
| <td class="paramname"> <em>...</em></td><td> </td> |
| </tr> |
| <tr> |
| <td></td> |
| <td>)</td> |
| <td></td><td></td><td></td> |
| </tr> |
| </table> |
| </div> |
| <div class="memdoc"> |
| <p>Constructor with an integer value for SQLSTATE</p> |
| <dl><dt><b>Parameters:</b></dt><dd> |
| <table border="0" cellspacing="2" cellpadding="0"> |
| <tr><td valign="top"></td><td valign="top"><em>sqlState</em> </td><td>ISO/ANSI SQLSTATE value to produce for this error. According to the standard, this must be a value in the range of 38000 - 38999 (note that since we use an integer, non-numeric SQLSTATE values cannot be generated. </td></tr> |
| <tr><td valign="top"></td><td valign="top"><em>printf_format</em> </td><td>a format string like it is used in printf, with a variable list of arguments to be substituted. Example: new <a class="el" href="classtmudr_1_1UDRException.html" title="This is the exception to throw when an error occurs in a UDR.">UDRException</a>(38001, "num %d, string %s", 1, "a"); </td></tr> |
| </table> |
| </dd> |
| </dl> |
| |
| </div> |
| </div> |
| <a class="anchor" id="a1d565a22c7a46717c688de64ab56f755"></a><!-- doxytag: member="tmudr::UDRException::UDRException" ref="a1d565a22c7a46717c688de64ab56f755" args="(const char *sqlState, const char *printf_format,...)" --> |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">UDRException::UDRException </td> |
| <td>(</td> |
| <td class="paramtype">const char * </td> |
| <td class="paramname"> <em>sqlState</em>, </td> |
| </tr> |
| <tr> |
| <td class="paramkey"></td> |
| <td></td> |
| <td class="paramtype">const char * </td> |
| <td class="paramname"> <em>printf_format</em>, </td> |
| </tr> |
| <tr> |
| <td class="paramkey"></td> |
| <td></td> |
| <td class="paramtype"> </td> |
| <td class="paramname"> <em>...</em></td><td> </td> |
| </tr> |
| <tr> |
| <td></td> |
| <td>)</td> |
| <td></td><td></td><td></td> |
| </tr> |
| </table> |
| </div> |
| <div class="memdoc"> |
| <p>Constructor with a string value for SQLSTATE</p> |
| <dl><dt><b>Parameters:</b></dt><dd> |
| <table border="0" cellspacing="2" cellpadding="0"> |
| <tr><td valign="top"></td><td valign="top"><em>sqlState</em> </td><td>ISO/ANSI SQLSTATE value to produce for this error. According to the standard, this must be a value of the form 38xxx, with the xxx being digits or upper case letters. </td></tr> |
| <tr><td valign="top"></td><td valign="top"><em>printf_format</em> </td><td>a format string like it is used in printf, with a variable list of arguments to be substituted. </td></tr> |
| </table> |
| </dd> |
| </dl> |
| |
| </div> |
| </div> |
| <hr/><h2>Member Function Documentation</h2> |
| <a class="anchor" id="aa9d80f9be4771b873ca0ef2044e63306"></a><!-- doxytag: member="tmudr::UDRException::getMessage" ref="aa9d80f9be4771b873ca0ef2044e63306" args="() const " --> |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">const std::string & UDRException::getMessage </td> |
| <td>(</td> |
| <td class="paramname"></td> |
| <td> ) </td> |
| <td> const</td> |
| </tr> |
| </table> |
| </div> |
| <div class="memdoc"> |
| <p>Get the error message associated with this exception</p> |
| <dl class="return"><dt><b>Returns:</b></dt><dd>A string, representing the error message, including any substituted text with the additional arguments in the constructor. Note that this is a reference to a data member, it lives only as long as the <a class="el" href="classtmudr_1_1UDRException.html" title="This is the exception to throw when an error occurs in a UDR.">UDRException</a> object. </dd></dl> |
| |
| </div> |
| </div> |
| <a class="anchor" id="ab72a1a01900f1cc7f0ac28cba5b2092d"></a><!-- doxytag: member="tmudr::UDRException::getSQLState" ref="ab72a1a01900f1cc7f0ac28cba5b2092d" args="() const " --> |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">const char * UDRException::getSQLState </td> |
| <td>(</td> |
| <td class="paramname"></td> |
| <td> ) </td> |
| <td> const</td> |
| </tr> |
| </table> |
| </div> |
| <div class="memdoc"> |
| <p>Get the SQSTATE value for this exception</p> |
| <dl class="return"><dt><b>Returns:</b></dt><dd>A string, representing the SQLSTATE. Note that this is a pointer to a data member, the buffer lives only as long as the <a class="el" href="classtmudr_1_1UDRException.html" title="This is the exception to throw when an error occurs in a UDR.">UDRException</a> object. </dd></dl> |
| |
| </div> |
| </div> |
| <a class="anchor" id="a1fbcd51c04fd8253403bef5c7d5b0879"></a><!-- doxytag: member="tmudr::UDRException::getText" ref="a1fbcd51c04fd8253403bef5c7d5b0879" args="() const " --> |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">const std::string & UDRException::getText </td> |
| <td>(</td> |
| <td class="paramname"></td> |
| <td> ) </td> |
| <td> const</td> |
| </tr> |
| </table> |
| </div> |
| <div class="memdoc"> |
| <p>Get the error message associated with this exception</p> |
| <dl class="return"><dt><b>Returns:</b></dt><dd>Same as <a class="el" href="classtmudr_1_1UDRException.html#aa9d80f9be4771b873ca0ef2044e63306">getMessage()</a>.</dd></dl> |
| <dl class="deprecated"><dt><b><a class="el" href="deprecated.html#_deprecated000001">Deprecated:</a></b></dt><dd>Use <a class="el" href="classtmudr_1_1UDRException.html#aa9d80f9be4771b873ca0ef2044e63306">getMessage()</a> instead, in Java that is the standard method. </dd></dl> |
| |
| </div> |
| </div> |
| <hr/>The documentation for this class was generated from the following files:<ul> |
| <li><a class="el" href="sqludr_8h_source.html">sqludr.h</a></li> |
| <li>sqludr.cpp</li> |
| </ul> |
| </div> |
| <!--- window showing the filter options --> |
| <div id="MSearchSelectWindow" |
| onmouseover="return searchBox.OnSearchSelectShow()" |
| onmouseout="return searchBox.OnSearchSelectHide()" |
| onkeydown="return searchBox.OnSearchSelectKey(event)"> |
| <a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(0)"><span class="SelectionMark"> </span>All</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(1)"><span class="SelectionMark"> </span>Data Structures</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(2)"><span class="SelectionMark"> </span>Functions</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(3)"><span class="SelectionMark"> </span>Enumerations</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(4)"><span class="SelectionMark"> </span>Enumerator</a></div> |
| |
| <!-- iframe showing the search results (closed by default) --> |
| <div id="MSearchResultsWindow"> |
| <iframe src="" frameborder="0" |
| name="MSearchResults" id="MSearchResults"> |
| </iframe> |
| </div> |
| |
| <hr size="1"/><address style="text-align: right;"><small>Generated on 2 May 2020 for tmudr by |
| <a href="http://www.doxygen.org/index.html"> |
| <img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.6.1 </small></address> |
| </body> |
| </html> |
