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
|
<!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++: mysqlpp::SQLParseElement Struct 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 id="nav-path" class="navpath">
<ul>
<li class="navelem"><b>mysqlpp</b></li><li class="navelem"><a class="el" href="structmysqlpp_1_1SQLParseElement.html">SQLParseElement</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="summary">
<a href="#pub-methods">Public Member Functions</a> |
<a href="#pub-attribs">Public Attributes</a> |
<a href="structmysqlpp_1_1SQLParseElement-members.html">List of all members</a> </div>
<div class="headertitle">
<div class="title">mysqlpp::SQLParseElement Struct Reference</div> </div>
</div><!--header-->
<div class="contents">
<p>Used within <a class="el" href="classmysqlpp_1_1Query.html" title="A class for building and executing SQL queries.">Query</a> to hold elements for parameterized queries.
<a href="structmysqlpp_1_1SQLParseElement.html#details">More...</a></p>
<p><code>#include <<a class="el" href="qparms_8h_source.html">qparms.h</a>></code></p>
<div class="dynheader">
Collaboration diagram for mysqlpp::SQLParseElement:</div>
<div class="dyncontent">
<div class="center"><img src="structmysqlpp_1_1SQLParseElement__coll__graph.png" border="0" usemap="#mysqlpp_1_1SQLParseElement_coll__map" alt="Collaboration graph"/></div>
<map name="mysqlpp_1_1SQLParseElement_coll__map" id="mysqlpp_1_1SQLParseElement_coll__map">
<area shape="rect" title="Used within Query to hold elements for parameterized queries." alt="" coords="5,92,194,117"/>
<area shape="rect" title=" " alt="" coords="73,5,127,31"/>
</map>
<center><span class="legend">[<a href="graph_legend.html">legend</a>]</span></center></div>
<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:a5095f861effa2f1695c3cc29f79f825e"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="structmysqlpp_1_1SQLParseElement.html#a5095f861effa2f1695c3cc29f79f825e">SQLParseElement</a> (std::string b, char o, signed char n)</td></tr>
<tr class="memdesc:a5095f861effa2f1695c3cc29f79f825e"><td class="mdescLeft"> </td><td class="mdescRight">Create object. <a href="#a5095f861effa2f1695c3cc29f79f825e">More...</a><br /></td></tr>
<tr class="separator:a5095f861effa2f1695c3cc29f79f825e"><td class="memSeparator" colspan="2"> </td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-attribs"></a>
Public Attributes</h2></td></tr>
<tr class="memitem:a8b0a5afd4a8b825d13579b1427e94331"><td class="memItemLeft" align="right" valign="top"><a id="a8b0a5afd4a8b825d13579b1427e94331"></a>
std::string </td><td class="memItemRight" valign="bottom"><a class="el" href="structmysqlpp_1_1SQLParseElement.html#a8b0a5afd4a8b825d13579b1427e94331">before</a></td></tr>
<tr class="memdesc:a8b0a5afd4a8b825d13579b1427e94331"><td class="mdescLeft"> </td><td class="mdescRight">string inserted before the parameter <br /></td></tr>
<tr class="separator:a8b0a5afd4a8b825d13579b1427e94331"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a99ca4660111774c7bdfc5d0a142d9f00"><td class="memItemLeft" align="right" valign="top"><a id="a99ca4660111774c7bdfc5d0a142d9f00"></a>
char </td><td class="memItemRight" valign="bottom"><a class="el" href="structmysqlpp_1_1SQLParseElement.html#a99ca4660111774c7bdfc5d0a142d9f00">option</a></td></tr>
<tr class="memdesc:a99ca4660111774c7bdfc5d0a142d9f00"><td class="mdescLeft"> </td><td class="mdescRight">the parameter option, or blank if none <br /></td></tr>
<tr class="separator:a99ca4660111774c7bdfc5d0a142d9f00"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:adad4d34b5d3435cf327382a0cc343323"><td class="memItemLeft" align="right" valign="top"><a id="adad4d34b5d3435cf327382a0cc343323"></a>
signed char </td><td class="memItemRight" valign="bottom"><a class="el" href="structmysqlpp_1_1SQLParseElement.html#adad4d34b5d3435cf327382a0cc343323">num</a></td></tr>
<tr class="memdesc:adad4d34b5d3435cf327382a0cc343323"><td class="mdescLeft"> </td><td class="mdescRight">the parameter position to use <br /></td></tr>
<tr class="separator:adad4d34b5d3435cf327382a0cc343323"><td class="memSeparator" colspan="2"> </td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p>Used within <a class="el" href="classmysqlpp_1_1Query.html" title="A class for building and executing SQL queries.">Query</a> to hold elements for parameterized queries. </p>
<p>Each element has three parts:</p>
<p>The concept behind the <code>before</code> variable needs a little explaining. When a template query is parsed, each parameter is parsed into one of these <a class="el" href="structmysqlpp_1_1SQLParseElement.html" title="Used within Query to hold elements for parameterized queries.">SQLParseElement</a> objects, but the non-parameter parts of the template also have to be stored somewhere. MySQL++ chooses to attach the text leading up to a parameter to that parameter. So, the <code>before</code> string is simply the text copied literally into the finished query before we insert a value for the parameter.</p>
<p>The <code>option</code> character is currently one of 'q', 'Q', 'r', 'R' or ' '. See the "Template Queries" chapter in the user manual for details.</p>
<p>The position value (<code>num</code>) allows a template query to have its parameters in a different order than in the <a class="el" href="classmysqlpp_1_1Query.html" title="A class for building and executing SQL queries.">Query</a> method call. An example of how this can be helpful is in the "Template Queries" chapter of the user manual. </p>
</div><h2 class="groupheader">Constructor & Destructor Documentation</h2>
<a id="a5095f861effa2f1695c3cc29f79f825e"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a5095f861effa2f1695c3cc29f79f825e">◆ </a></span>SQLParseElement()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">mysqlpp::SQLParseElement::SQLParseElement </td>
<td>(</td>
<td class="paramtype">std::string </td>
<td class="paramname"><em>b</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">char </td>
<td class="paramname"><em>o</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">signed char </td>
<td class="paramname"><em>n</em> </td>
</tr>
<tr>
<td></td>
<td>)</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>Create object. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">b</td><td>the 'before' value </td></tr>
<tr><td class="paramname">o</td><td>the 'option' value </td></tr>
<tr><td class="paramname">n</td><td>the 'num' value </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<hr/>The documentation for this struct was generated from the following file:<ul>
<li><a class="el" href="qparms_8h_source.html">qparms.h</a></li>
</ul>
</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>
|