File: classmysqlpp_1_1StoreQueryResult.html

package info (click to toggle)
mysql%2B%2B 3.2.1%2Bpristine-1
  • links: PTS
  • area: main
  • in suites: jessie, jessie-kfreebsd
  • size: 13,624 kB
  • ctags: 11,252
  • sloc: cpp: 35,659; sh: 3,034; makefile: 951; perl: 786
file content (111 lines) | stat: -rw-r--r-- 9,961 bytes parent folder | download
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
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
	<title>MySQL++ Reference Manual</title>
	<meta http-equiv="Content-type" content="text/html;charset=iso-8859-1">
	<link href="doxygen.css" rel="stylesheet" type="text/css">
	<link href="refman.css" rel="stylesheet" type="text/css">
</head>
<body>
<!-- Generated by Doxygen 1.4.7 -->
<div class="tabs">
  <ul>
    <li><a href="index.html"><span>Main&nbsp;Page</span></a></li>
    <li><a href="namespaces.html"><span>Namespaces</span></a></li>
    <li id="current"><a href="annotated.html"><span>Classes</span></a></li>
    <li><a href="files.html"><span>Files</span></a></li>
  </ul></div>
<div class="tabs">
  <ul>
    <li><a href="annotated.html"><span>Class&nbsp;List</span></a></li>
    <li><a href="hierarchy.html"><span>Class&nbsp;Hierarchy</span></a></li>
    <li><a href="functions.html"><span>Class&nbsp;Members</span></a></li>
  </ul></div>
<div class="nav">
<b>mysqlpp</b>::<a class="el" href="classmysqlpp_1_1StoreQueryResult.html">StoreQueryResult</a></div>
<h1>mysqlpp::StoreQueryResult Class Reference</h1><!-- doxytag: class="mysqlpp::StoreQueryResult" --><!-- doxytag: inherits="mysqlpp::ResultBase" --><a class="el" href="classmysqlpp_1_1StoreQueryResult.html">StoreQueryResult</a> set type for "store" queries.  
<a href="#_details">More...</a>
<p>
<code>#include &lt;<a class="el" href="result_8h-source.html">result.h</a>&gt;</code>
<p>
Inheritance diagram for mysqlpp::StoreQueryResult:<p><center><img src="classmysqlpp_1_1StoreQueryResult__inherit__graph.png" border="0" usemap="#mysqlpp_1_1StoreQueryResult__inherit__map" alt="Inheritance graph"></center>
<map name="mysqlpp_1_1StoreQueryResult__inherit__map">
<area href="classmysqlpp_1_1ResultBase.html" shape="rect" coords="33,80,191,107" alt="">
<area href="classmysqlpp_1_1OptionalExceptions.html" shape="rect" coords="5,5,219,32" alt="">
</map>
<center><font size="2">[<a href="graph_legend.html">legend</a>]</font></center>Collaboration diagram for mysqlpp::StoreQueryResult:<p><center><img src="classmysqlpp_1_1StoreQueryResult__coll__graph.png" border="0" usemap="#mysqlpp_1_1StoreQueryResult__coll__map" alt="Collaboration graph"></center>
<map name="mysqlpp_1_1StoreQueryResult__coll__map">
<area href="classmysqlpp_1_1ResultBase.html" shape="rect" coords="95,187,252,213" alt="">
<area href="classmysqlpp_1_1OptionalExceptions.html" shape="rect" coords="5,96,219,123" alt="">
<area href="classmysqlpp_1_1DBDriver.html" shape="rect" coords="243,96,389,123" alt="">
</map>
<center><font size="2">[<a href="graph_legend.html">legend</a>]</font></center><a href="classmysqlpp_1_1StoreQueryResult-members.html">List of all members.</a><table border="0" cellpadding="0" cellspacing="0">
<tr><td></td></tr>
<tr><td colspan="2"><br><h2>Public Types</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="c5a4eb33883201e9e8d21d41fecd80d0"></a><!-- doxytag: member="mysqlpp::StoreQueryResult::list_type" ref="c5a4eb33883201e9e8d21d41fecd80d0" args="" -->
typedef std::vector&lt; <a class="el" href="classmysqlpp_1_1Row.html">Row</a> &gt;&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classmysqlpp_1_1StoreQueryResult.html#c5a4eb33883201e9e8d21d41fecd80d0">list_type</a></td></tr>

<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">type of vector base class <br></td></tr>
<tr><td colspan="2"><br><h2>Public Member Functions</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="0db61dd318b1e02d8c72bbce1fd12f2a"></a><!-- doxytag: member="mysqlpp::StoreQueryResult::StoreQueryResult" ref="0db61dd318b1e02d8c72bbce1fd12f2a" args="()" -->
&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classmysqlpp_1_1StoreQueryResult.html#0db61dd318b1e02d8c72bbce1fd12f2a">StoreQueryResult</a> ()</td></tr>

<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Default constructor. <br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="80f379be1da2a5d35f248bd9f4423c2a"></a><!-- doxytag: member="mysqlpp::StoreQueryResult::StoreQueryResult" ref="80f379be1da2a5d35f248bd9f4423c2a" args="(MYSQL_RES *result, DBDriver *dbd, bool te=true)" -->
&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classmysqlpp_1_1StoreQueryResult.html#80f379be1da2a5d35f248bd9f4423c2a">StoreQueryResult</a> (MYSQL_RES *result, <a class="el" href="classmysqlpp_1_1DBDriver.html">DBDriver</a> *dbd, bool te=true)</td></tr>

<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Fully initialize object. <br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="3754c274c83f045bc3772e821c97629b"></a><!-- doxytag: member="mysqlpp::StoreQueryResult::StoreQueryResult" ref="3754c274c83f045bc3772e821c97629b" args="(const StoreQueryResult &amp;other)" -->
&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classmysqlpp_1_1StoreQueryResult.html#3754c274c83f045bc3772e821c97629b">StoreQueryResult</a> (const <a class="el" href="classmysqlpp_1_1StoreQueryResult.html">StoreQueryResult</a> &amp;other)</td></tr>

<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Initialize object as a copy of another <a class="el" href="classmysqlpp_1_1StoreQueryResult.html">StoreQueryResult</a> object. <br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="a4577436a49e8ccae60125daeec43d94"></a><!-- doxytag: member="mysqlpp::StoreQueryResult::~StoreQueryResult" ref="a4577436a49e8ccae60125daeec43d94" args="()" -->
&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classmysqlpp_1_1StoreQueryResult.html#a4577436a49e8ccae60125daeec43d94">~StoreQueryResult</a> ()</td></tr>

<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Destroy result set. <br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="8c7a6d4af07f469abea5c8354b371a89"></a><!-- doxytag: member="mysqlpp::StoreQueryResult::num_rows" ref="8c7a6d4af07f469abea5c8354b371a89" args="() const " -->
list_type::size_type&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classmysqlpp_1_1StoreQueryResult.html#8c7a6d4af07f469abea5c8354b371a89">num_rows</a> () const </td></tr>

<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Returns the number of rows in this result set. <br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="832e623301e516f7f31714bc7ed471b9"></a><!-- doxytag: member="mysqlpp::StoreQueryResult::operator=" ref="832e623301e516f7f31714bc7ed471b9" args="(const StoreQueryResult &amp;rhs)" -->
<a class="el" href="classmysqlpp_1_1StoreQueryResult.html">StoreQueryResult</a> &amp;&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classmysqlpp_1_1StoreQueryResult.html#832e623301e516f7f31714bc7ed471b9">operator=</a> (const <a class="el" href="classmysqlpp_1_1StoreQueryResult.html">StoreQueryResult</a> &amp;rhs)</td></tr>

<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Copy another <a class="el" href="classmysqlpp_1_1StoreQueryResult.html">StoreQueryResult</a> object's data into this object. <br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classmysqlpp_1_1StoreQueryResult.html#18032e96aff8a48636cda4e89062b706">operator private_bool_type</a> () const </td></tr>

<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Test whether the query that created this result succeeded.  <a href="#18032e96aff8a48636cda4e89062b706"></a><br></td></tr>
</table>
<hr><a name="_details"></a><h2>Detailed Description</h2>
<a class="el" href="classmysqlpp_1_1StoreQueryResult.html">StoreQueryResult</a> set type for "store" queries. 
<p>
This is the obvious C++ implementation of a class to hold results from a SQL query that returns rows: a specialization of std::vector holding <a class="el" href="classmysqlpp_1_1Row.html">Row</a> objects in memory so you get random-access semantics. MySQL++ also supports <a class="el" href="classmysqlpp_1_1UseQueryResult.html">UseQueryResult</a> which is less friendly, but has better memory performance. See the user manual for more details on the distinction and the usage patterns required. 
<p>
<hr><h2>Member Function Documentation</h2>
<a class="anchor" name="18032e96aff8a48636cda4e89062b706"></a><!-- doxytag: member="mysqlpp::StoreQueryResult::operator private_bool_type" ref="18032e96aff8a48636cda4e89062b706" args="() const " -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">mysqlpp::StoreQueryResult::operator private_bool_type           </td>
          <td>(</td>
          <td class="paramname">          </td>
          <td>&nbsp;)&nbsp;</td>
          <td width="100%"> const<code> [inline]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>
Test whether the query that created this result succeeded. 
<p>
If you test this object in bool context and it's false, it's a signal that the query this was created from failed in some way. Call <a class="el" href="classmysqlpp_1_1Query.html#24ddaff8ae037c56c1a5aceda34e89c8">Query::error()</a> or <a class="el" href="classmysqlpp_1_1Query.html#3acf442e091bdfb5344cbe9990f05f3b">Query::errnum()</a> to find out what exactly happened. 
</div>
</div><p>
<hr>The documentation for this class was generated from the following files:<ul>
<li><a class="el" href="result_8h-source.html">result.h</a><li>result.cpp</ul>
<hr size="1"><address style="align: right;"><small>Generated on 10 Dec 2013 for MySQL++ by&nbsp;
<a href="http://www.doxygen.org/index.html">
<img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.4.7 </small></address>
</body>
</html>