1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189
|
<!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>
<title>MySQL++ Reference Manual</title>
<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.15"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>MySQL++: mysql++.h File Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<link href="doxygen.css" rel="stylesheet" type="text/css">
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/searchdata.js"></script>
<script type="text/javascript" src="search/search.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 id="projectalign" style="padding-left: 0.5em;">
<div id="projectname">MySQL++
 <span id="projectnumber">3.2.5</span>
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.15 -->
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&dn=gpl-2.0.txt GPL-v2 */
var searchBox = new SearchBox("searchBox", "search",false,'Search');
/* @license-end */
</script>
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&dn=gpl-2.0.txt GPL-v2 */
$(function() {
initMenu('',true,false,'search.php','Search');
$(document).ready(function() { init_search(); });
});
/* @license-end */</script>
<div id="main-nav"></div>
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
onkeydown="return searchBox.OnSearchSelectKey(event)">
</div>
<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<iframe src="javascript:void(0)" frameborder="0"
name="MSearchResults" id="MSearchResults">
</iframe>
</div>
</div><!-- top -->
<div class="header">
<div class="summary">
<a href="#define-members">Macros</a> |
<a href="#func-members">Functions</a> </div>
<div class="headertitle">
<div class="title">mysql++.h File Reference</div> </div>
</div><!--header-->
<div class="contents">
<p>The main MySQL++ header file.
<a href="#details">More...</a></p>
<div class="textblock"><code>#include "<a class="el" href="connection_8h_source.html">connection.h</a>"</code><br />
<code>#include "<a class="el" href="cpool_8h_source.html">cpool.h</a>"</code><br />
<code>#include "<a class="el" href="query_8h_source.html">query.h</a>"</code><br />
<code>#include "<a class="el" href="scopedconnection_8h_source.html">scopedconnection.h</a>"</code><br />
<code>#include "<a class="el" href="sql__types_8h_source.html">sql_types.h</a>"</code><br />
<code>#include "<a class="el" href="transaction_8h_source.html">transaction.h</a>"</code><br />
</div>
<p><a href="mysql_09_09_8h_source.html">Go to the source code of this file.</a></p>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="define-members"></a>
Macros</h2></td></tr>
<tr class="memitem:a9e2bea148cfa102c37bad4ec0d79bb3c"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="mysql_09_09_8h.html#a9e2bea148cfa102c37bad4ec0d79bb3c">MYSQLPP_VERSION</a>(major, minor, bugfix)   (((major) << 16) | ((minor) << 8) | (bugfix))</td></tr>
<tr class="memdesc:a9e2bea148cfa102c37bad4ec0d79bb3c"><td class="mdescLeft"> </td><td class="mdescRight">Encode MySQL++ library version number. <a href="#a9e2bea148cfa102c37bad4ec0d79bb3c">More...</a><br /></td></tr>
<tr class="separator:a9e2bea148cfa102c37bad4ec0d79bb3c"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:aa5519915a48d82e2f6958f059ed41079"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="mysql_09_09_8h.html#aa5519915a48d82e2f6958f059ed41079">MYSQLPP_HEADER_VERSION</a>   <a class="el" href="mysql_09_09_8h.html#a9e2bea148cfa102c37bad4ec0d79bb3c">MYSQLPP_VERSION</a>(3, 2, 5)</td></tr>
<tr class="memdesc:aa5519915a48d82e2f6958f059ed41079"><td class="mdescLeft"> </td><td class="mdescRight">Get the library version number that mysql++.h comes from. <a href="#aa5519915a48d82e2f6958f059ed41079">More...</a><br /></td></tr>
<tr class="separator:aa5519915a48d82e2f6958f059ed41079"><td class="memSeparator" colspan="2"> </td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="func-members"></a>
Functions</h2></td></tr>
<tr class="memitem:afabd9abe95c067bca33601a61b45ee10"><td class="memItemLeft" align="right" valign="top">unsigned int </td><td class="memItemRight" valign="bottom"><b>mysqlpp::get_library_version</b> ()</td></tr>
<tr class="memdesc:afabd9abe95c067bca33601a61b45ee10"><td class="mdescLeft"> </td><td class="mdescRight">Get the current MySQL++ library version number. <a href="mysql_09_09_8cpp.html#afabd9abe95c067bca33601a61b45ee10">More...</a><br /></td></tr>
<tr class="separator:afabd9abe95c067bca33601a61b45ee10"><td class="memSeparator" colspan="2"> </td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p>The main MySQL++ header file. </p>
<p>This file brings in all MySQL++ headers except for custom.h and custom-macros.h which are a strictly optional feature of MySQL++.</p>
<p>There is no point in trying to optimize which headers you include, because the MySQL++ headers are so intertwined. You can only get trivial compile time benefits, at the expense of clarity. </p>
</div><h2 class="groupheader">Macro Definition Documentation</h2>
<a id="aa5519915a48d82e2f6958f059ed41079"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aa5519915a48d82e2f6958f059ed41079">◆ </a></span>MYSQLPP_HEADER_VERSION</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define MYSQLPP_HEADER_VERSION   <a class="el" href="mysql_09_09_8h.html#a9e2bea148cfa102c37bad4ec0d79bb3c">MYSQLPP_VERSION</a>(3, 2, 5)</td>
</tr>
</table>
</div><div class="memdoc">
<p>Get the library version number that mysql++.h comes from. </p>
<p>MySQL++ Version number that the mysql++.h header file comes from, encoded by MYSQLPP_VERSION macro. Compare this value to what get_library_version() returns in order to ensure that your program is using header files from the same version of MySQL++ as the actual library you're linking to. </p>
</div>
</div>
<a id="a9e2bea148cfa102c37bad4ec0d79bb3c"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a9e2bea148cfa102c37bad4ec0d79bb3c">◆ </a></span>MYSQLPP_VERSION</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define MYSQLPP_VERSION</td>
<td>(</td>
<td class="paramtype"> </td>
<td class="paramname">major, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"> </td>
<td class="paramname">minor, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"> </td>
<td class="paramname">bugfix </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td>   (((major) << 16) | ((minor) << 8) | (bugfix))</td>
</tr>
</table>
</div><div class="memdoc">
<p>Encode MySQL++ library version number. </p>
<p>This macro takes major, minor and bugfix numbers (e.g. 1, 2, and 3) and encodes them like 0x010203. </p>
</div>
</div>
<h2 class="groupheader">Function Documentation</h2>
<a id="file_afabd9abe95c067bca33601a61b45ee10"></a>
<h2 class="memtitle"><span class="permalink"><a href="#file_afabd9abe95c067bca33601a61b45ee10">◆ </a></span>get_library_version()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">MYSQLPP_EXPORT unsigned int mysqlpp::get_library_version </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Get the current MySQL++ library version number. </p>
<p>MySQL++ version number that the program is actually linked to, encoded by MYSQLPP_VERSION macro. Compare this value to the MYSQLPP_HEADER_VERSION constant in order to ensure that your program is using header files from the same version of MySQL++ as the actual library you're linking to. </p>
</div>
</div>
</div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated on Sun Jul 21 2019 05:32:21 for MySQL++ by  <a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/>
</a> 1.8.15
</small></address>
</body>
</html>
|