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
|
<!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 Page</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 List</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 class="nav">
<b>mysqlpp</b>::<a class="el" href="classmysqlpp_1_1UseQueryResult.html">UseQueryResult</a></div>
<h1>mysqlpp::UseQueryResult Class Reference</h1><!-- doxytag: class="mysqlpp::UseQueryResult" --><!-- doxytag: inherits="mysqlpp::ResultBase" --><a class="el" href="classmysqlpp_1_1StoreQueryResult.html">StoreQueryResult</a> set type for "use" queries.
<a href="#_details">More...</a>
<p>
<code>#include <<a class="el" href="result_8h-source.html">result.h</a>></code>
<p>
Inheritance diagram for mysqlpp::UseQueryResult:<p><center><img src="classmysqlpp_1_1UseQueryResult__inherit__graph.png" border="0" usemap="#mysqlpp_1_1UseQueryResult__inherit__map" alt="Inheritance graph"></center>
<map name="mysqlpp_1_1UseQueryResult__inherit__map">
<area href="classmysqlpp_1_1ResultBase.html" shape="rect" coords="33,81,191,105" alt="">
<area href="classmysqlpp_1_1OptionalExceptions.html" shape="rect" coords="5,7,219,31" alt="">
</map>
<center><font size="2">[<a href="graph_legend.html">legend</a>]</font></center>Collaboration diagram for mysqlpp::UseQueryResult:<p><center><img src="classmysqlpp_1_1UseQueryResult__coll__graph.png" border="0" usemap="#mysqlpp_1_1UseQueryResult__coll__map" alt="Collaboration graph"></center>
<map name="mysqlpp_1_1UseQueryResult__coll__map">
<area href="classmysqlpp_1_1ResultBase.html" shape="rect" coords="236,188,393,212" alt="">
<area href="classmysqlpp_1_1OptionalExceptions.html" shape="rect" coords="5,97,219,121" alt="">
<area href="classmysqlpp_1_1DBDriver.html" shape="rect" coords="243,97,389,121" alt="">
<area href="classmysqlpp_1_1RefCountedPointer.html" shape="rect" coords="417,188,732,212" alt="">
<area href="classmysqlpp_1_1RefCountedPointer.html" shape="rect" coords="415,97,735,121" alt="">
</map>
<center><font size="2">[<a href="graph_legend.html">legend</a>]</font></center><a href="classmysqlpp_1_1UseQueryResult-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 Member Functions</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="8c4596a5f7b1aab0d4ef6939a67de10c"></a><!-- doxytag: member="mysqlpp::UseQueryResult::UseQueryResult" ref="8c4596a5f7b1aab0d4ef6939a67de10c" args="()" -->
</td><td class="memItemRight" valign="bottom"><a class="el" href="classmysqlpp_1_1UseQueryResult.html#8c4596a5f7b1aab0d4ef6939a67de10c">UseQueryResult</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Default constructor. <br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="e8e54798b2f62788f2741da6d91b69f9"></a><!-- doxytag: member="mysqlpp::UseQueryResult::UseQueryResult" ref="e8e54798b2f62788f2741da6d91b69f9" args="(MYSQL_RES *result, DBDriver *dbd, bool te=true)" -->
</td><td class="memItemRight" valign="bottom"><a class="el" href="classmysqlpp_1_1UseQueryResult.html#e8e54798b2f62788f2741da6d91b69f9">UseQueryResult</a> (MYSQL_RES *result, <a class="el" href="classmysqlpp_1_1DBDriver.html">DBDriver</a> *dbd, bool te=true)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Create the object, fully initialized. <br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="8a68bb41c82a36c534cd1c128f559cfb"></a><!-- doxytag: member="mysqlpp::UseQueryResult::UseQueryResult" ref="8a68bb41c82a36c534cd1c128f559cfb" args="(const UseQueryResult &other)" -->
</td><td class="memItemRight" valign="bottom"><a class="el" href="classmysqlpp_1_1UseQueryResult.html#8a68bb41c82a36c534cd1c128f559cfb">UseQueryResult</a> (const <a class="el" href="classmysqlpp_1_1UseQueryResult.html">UseQueryResult</a> &other)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Create a copy of another <a class="el" href="classmysqlpp_1_1UseQueryResult.html">UseQueryResult</a> object. <br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="3077144651e05dfc524ab373bee13384"></a><!-- doxytag: member="mysqlpp::UseQueryResult::~UseQueryResult" ref="3077144651e05dfc524ab373bee13384" args="()" -->
</td><td class="memItemRight" valign="bottom"><a class="el" href="classmysqlpp_1_1UseQueryResult.html#3077144651e05dfc524ab373bee13384">~UseQueryResult</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Destroy object. <br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="2c7f55f092e888911acca535d630fbf2"></a><!-- doxytag: member="mysqlpp::UseQueryResult::operator=" ref="2c7f55f092e888911acca535d630fbf2" args="(const UseQueryResult &rhs)" -->
<a class="el" href="classmysqlpp_1_1UseQueryResult.html">UseQueryResult</a> & </td><td class="memItemRight" valign="bottom"><a class="el" href="classmysqlpp_1_1UseQueryResult.html#2c7f55f092e888911acca535d630fbf2">operator=</a> (const <a class="el" href="classmysqlpp_1_1UseQueryResult.html">UseQueryResult</a> &rhs)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Copy another <a class="el" href="classmysqlpp_1_1UseQueryResult.html">UseQueryResult</a> object's data into this object. <br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="b3d658c0056b5735ae84f6f5880d6838"></a><!-- doxytag: member="mysqlpp::UseQueryResult::fetch_field" ref="b3d658c0056b5735ae84f6f5880d6838" args="() const " -->
const <a class="el" href="classmysqlpp_1_1Field.html">Field</a> & </td><td class="memItemRight" valign="bottom"><a class="el" href="classmysqlpp_1_1UseQueryResult.html#b3d658c0056b5735ae84f6f5880d6838">fetch_field</a> () const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Returns the next field in this result set. <br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="59a804504c06b525c0e2ddcbf405a1c1"></a><!-- doxytag: member="mysqlpp::UseQueryResult::fetch_field" ref="59a804504c06b525c0e2ddcbf405a1c1" args="(Fields::size_type i) const " -->
const <a class="el" href="classmysqlpp_1_1Field.html">Field</a> & </td><td class="memItemRight" valign="bottom"><a class="el" href="classmysqlpp_1_1UseQueryResult.html#59a804504c06b525c0e2ddcbf405a1c1">fetch_field</a> (Fields::size_type i) const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Returns the given field in this result set. <br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="cb3d808be2f9c3becf388f8d848b5cb4"></a><!-- doxytag: member="mysqlpp::UseQueryResult::fetch_lengths" ref="cb3d808be2f9c3becf388f8d848b5cb4" args="() const " -->
const unsigned long * </td><td class="memItemRight" valign="bottom"><a class="el" href="classmysqlpp_1_1UseQueryResult.html#cb3d808be2f9c3becf388f8d848b5cb4">fetch_lengths</a> () const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Returns the lengths of the fields in the current row of the result set. <br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="classmysqlpp_1_1Row.html">Row</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classmysqlpp_1_1UseQueryResult.html#d5392e08b52a64737a6edb966a61d005">fetch_row</a> () const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Returns the next row in a "use" query's result set. <a href="#d5392e08b52a64737a6edb966a61d005"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="7f55278a80a133a83bdfd22effc58860"></a><!-- doxytag: member="mysqlpp::UseQueryResult::fetch_raw_row" ref="7f55278a80a133a83bdfd22effc58860" args="() const " -->
MYSQL_ROW </td><td class="memItemRight" valign="bottom"><a class="el" href="classmysqlpp_1_1UseQueryResult.html#7f55278a80a133a83bdfd22effc58860">fetch_raw_row</a> () const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Wraps mysql_fetch_row() in MySQL C API. <br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classmysqlpp_1_1UseQueryResult.html#acedf05e8b5288c4ebd067cb01e7e880">field_seek</a> (Fields::size_type field) const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Jumps to the given field within the result set. <a href="#acedf05e8b5288c4ebd067cb01e7e880"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classmysqlpp_1_1UseQueryResult.html#da550462a5004024605fd472cc7430f0">operator MYSQL_RES *</a> () const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Return the pointer to the underlying MySQL C API result set object. <a href="#da550462a5004024605fd472cc7430f0"></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 "use" queries.
<p>
See the user manual for the reason you might want to use this even though its interface is less friendly than StoreQueryResult's.
<p>
<hr><h2>Member Function Documentation</h2>
<a class="anchor" name="d5392e08b52a64737a6edb966a61d005"></a><!-- doxytag: member="mysqlpp::UseQueryResult::fetch_row" ref="d5392e08b52a64737a6edb966a61d005" args="() const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classmysqlpp_1_1Row.html">Row</a> mysqlpp::UseQueryResult::fetch_row </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td width="100%"> const</td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Returns the next row in a "use" query's result set.
<p>
This is a thick wrapper around <a class="el" href="classmysqlpp_1_1DBDriver.html#c833701bed5f216b825aed5a772091e8">DBDriver::fetch_row()</a>. It does a lot of error checking before returning the <a class="el" href="classmysqlpp_1_1Row.html">Row</a> object containing the row data.<p>
<dl compact><dt><b>See also:</b></dt><dd><a class="el" href="classmysqlpp_1_1UseQueryResult.html#7f55278a80a133a83bdfd22effc58860">fetch_raw_row()</a> </dd></dl>
</div>
</div><p>
<a class="anchor" name="acedf05e8b5288c4ebd067cb01e7e880"></a><!-- doxytag: member="mysqlpp::UseQueryResult::field_seek" ref="acedf05e8b5288c4ebd067cb01e7e880" args="(Fields::size_type field) const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void mysqlpp::UseQueryResult::field_seek </td>
<td>(</td>
<td class="paramtype">Fields::size_type </td>
<td class="paramname"> <em>field</em> </td>
<td> ) </td>
<td width="100%"> const<code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Jumps to the given field within the result set.
<p>
Calling this allows you to reset the default field index used by <a class="el" href="classmysqlpp_1_1ResultBase.html#952749f63082ac42601672f2bc72a413">fetch_field()</a>.
</div>
</div><p>
<a class="anchor" name="da550462a5004024605fd472cc7430f0"></a><!-- doxytag: member="mysqlpp::UseQueryResult::operator MYSQL_RES *" ref="da550462a5004024605fd472cc7430f0" args="() const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">mysqlpp::UseQueryResult::operator MYSQL_RES * </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td width="100%"> const<code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Return the pointer to the underlying MySQL C API result set object.
<p>
<div class="fragment"><pre class="fragment">
<span class="comment">/// </span>
</pre></div>
</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 Fri Feb 29 16:26:48 2008 for MySQL++ by
<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>
|
