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
|
<!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><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 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_1Option.html">Option</a></div>
<h1>mysqlpp::Option Class Reference</h1><!-- doxytag: class="mysqlpp::Option" -->Define abstract interface for all *Option subclasses.
<a href="#_details">More...</a>
<p>
<code>#include <<a class="el" href="options_8h-source.html">options.h</a>></code>
<p>
Inheritance diagram for mysqlpp::Option:<p><center><img src="classmysqlpp_1_1Option__inherit__graph.png" border="0" usemap="#mysqlpp_1_1Option__inherit__map" alt="Inheritance graph"></center>
<map name="mysqlpp_1_1Option__inherit__map">
<area href="classmysqlpp_1_1CompressOption.html" shape="rect" coords="240,7,435,31" alt="">
<area href="classmysqlpp_1_1DataOption.html" shape="rect" coords="237,131,437,155" alt="">
<area href="classmysqlpp_1_1DataOption.html" shape="rect" coords="628,80,879,104" alt="">
<area href="classmysqlpp_1_1DataOption.html" shape="rect" coords="644,148,863,172" alt="">
<area href="classmysqlpp_1_1GuessConnectionOption.html" shape="rect" coords="216,229,459,253" alt="">
<area href="classmysqlpp_1_1NamedPipeOption.html" shape="rect" coords="235,277,440,301" alt="">
<area href="classmysqlpp_1_1SslOption.html" shape="rect" coords="263,325,412,349" alt="">
<area href="classmysqlpp_1_1UseEmbeddedConnectionOption.html" shape="rect" coords="188,373,487,397" alt="">
<area href="classmysqlpp_1_1UseRemoteConnectionOption.html" shape="rect" coords="197,421,477,445" alt="">
</map>
<center><font size="2">[<a href="graph_legend.html">legend</a>]</font></center><a href="classmysqlpp_1_1Option-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"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classmysqlpp_1_1Option.html#f0c0e22b32d2ee489bc77d360ce74c8c428c375eef3714cefac2c2c10396c14c">err_NONE</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">option was set successfully <a href="#f0c0e22b32d2ee489bc77d360ce74c8c428c375eef3714cefac2c2c10396c14c"></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_1Option.html#f0c0e22b32d2ee489bc77d360ce74c8c8006fc8212a2393a084f26d7980b8707">err_api_limit</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">option not supported by underlying C API <a href="#f0c0e22b32d2ee489bc77d360ce74c8c8006fc8212a2393a084f26d7980b8707"></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_1Option.html#f0c0e22b32d2ee489bc77d360ce74c8c3b6c862bd1548d5f4c28b62df8e600c6">err_api_reject</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">underlying C API returned error when setting option <a href="#f0c0e22b32d2ee489bc77d360ce74c8c3b6c862bd1548d5f4c28b62df8e600c6"></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_1Option.html#f0c0e22b32d2ee489bc77d360ce74c8cb6ee57a202c62afb4f66912137174973">err_connected</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">can't set the given option while connected <a href="#f0c0e22b32d2ee489bc77d360ce74c8cb6ee57a202c62afb4f66912137174973"></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_1Option.html#f0c0e22b32d2ee489bc77d360ce74c8c6d200a37429e238707384de5826cd270">err_disconnected</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">can only set the given option while connected <a href="#f0c0e22b32d2ee489bc77d360ce74c8c6d200a37429e238707384de5826cd270"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">enum </td><td class="memItemRight" valign="bottom"><a class="el" href="classmysqlpp_1_1Option.html#f0c0e22b32d2ee489bc77d360ce74c8c">Error</a> { <br>
<a class="el" href="classmysqlpp_1_1Option.html#f0c0e22b32d2ee489bc77d360ce74c8c428c375eef3714cefac2c2c10396c14c">err_NONE</a>,
<a class="el" href="classmysqlpp_1_1Option.html#f0c0e22b32d2ee489bc77d360ce74c8c8006fc8212a2393a084f26d7980b8707">err_api_limit</a>,
<a class="el" href="classmysqlpp_1_1Option.html#f0c0e22b32d2ee489bc77d360ce74c8c3b6c862bd1548d5f4c28b62df8e600c6">err_api_reject</a>,
<a class="el" href="classmysqlpp_1_1Option.html#f0c0e22b32d2ee489bc77d360ce74c8cb6ee57a202c62afb4f66912137174973">err_connected</a>,
<br>
<a class="el" href="classmysqlpp_1_1Option.html#f0c0e22b32d2ee489bc77d360ce74c8c6d200a37429e238707384de5826cd270">err_disconnected</a>
<br>
}</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Types of option setting errors we can diagnose. <a href="classmysqlpp_1_1Option.html#f0c0e22b32d2ee489bc77d360ce74c8c">More...</a><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="cf6f7585df2f41324516e45ad4856899"></a><!-- doxytag: member="mysqlpp::Option::~Option" ref="cf6f7585df2f41324516e45ad4856899" args="()" -->
virtual </td><td class="memItemRight" valign="bottom"><a class="el" href="classmysqlpp_1_1Option.html#cf6f7585df2f41324516e45ad4856899">~Option</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="b783846ebf48b7c7319cc045cb0b1828"></a><!-- doxytag: member="mysqlpp::Option::set" ref="b783846ebf48b7c7319cc045cb0b1828" args="(DBDriver *dbd)=0" -->
virtual <a class="el" href="classmysqlpp_1_1Option.html#f0c0e22b32d2ee489bc77d360ce74c8c">Error</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classmysqlpp_1_1Option.html#b783846ebf48b7c7319cc045cb0b1828">set</a> (<a class="el" href="classmysqlpp_1_1DBDriver.html">DBDriver</a> *dbd)=0</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Apply option. <br></td></tr>
</table>
<hr><a name="_details"></a><h2>Detailed Description</h2>
Define abstract interface for all *Option subclasses.
<p>
This is the base class for the mid-level interface classes that take arguments, plus the direct base for options that take no arguments.
<p>
<hr><h2>Member Enumeration Documentation</h2>
<a class="anchor" name="f0c0e22b32d2ee489bc77d360ce74c8c"></a><!-- doxytag: member="mysqlpp::Option::Error" ref="f0c0e22b32d2ee489bc77d360ce74c8c" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">enum <a class="el" href="classmysqlpp_1_1Option.html#f0c0e22b32d2ee489bc77d360ce74c8c">mysqlpp::Option::Error</a> </td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Types of option setting errors we can diagnose.
<p>
<dl compact><dt><b>Enumerator: </b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"><em><a class="anchor" name="f0c0e22b32d2ee489bc77d360ce74c8c428c375eef3714cefac2c2c10396c14c"></a><!-- doxytag: member="err_NONE" ref="f0c0e22b32d2ee489bc77d360ce74c8c428c375eef3714cefac2c2c10396c14c" args="" -->err_NONE</em> </td><td>
option was set successfully </td></tr>
<tr><td valign="top"><em><a class="anchor" name="f0c0e22b32d2ee489bc77d360ce74c8c8006fc8212a2393a084f26d7980b8707"></a><!-- doxytag: member="err_api_limit" ref="f0c0e22b32d2ee489bc77d360ce74c8c8006fc8212a2393a084f26d7980b8707" args="" -->err_api_limit</em> </td><td>
option not supported by underlying C API </td></tr>
<tr><td valign="top"><em><a class="anchor" name="f0c0e22b32d2ee489bc77d360ce74c8c3b6c862bd1548d5f4c28b62df8e600c6"></a><!-- doxytag: member="err_api_reject" ref="f0c0e22b32d2ee489bc77d360ce74c8c3b6c862bd1548d5f4c28b62df8e600c6" args="" -->err_api_reject</em> </td><td>
underlying C API returned error when setting option </td></tr>
<tr><td valign="top"><em><a class="anchor" name="f0c0e22b32d2ee489bc77d360ce74c8cb6ee57a202c62afb4f66912137174973"></a><!-- doxytag: member="err_connected" ref="f0c0e22b32d2ee489bc77d360ce74c8cb6ee57a202c62afb4f66912137174973" args="" -->err_connected</em> </td><td>
can't set the given option while connected </td></tr>
<tr><td valign="top"><em><a class="anchor" name="f0c0e22b32d2ee489bc77d360ce74c8c6d200a37429e238707384de5826cd270"></a><!-- doxytag: member="err_disconnected" ref="f0c0e22b32d2ee489bc77d360ce74c8c6d200a37429e238707384de5826cd270" args="" -->err_disconnected</em> </td><td>
can only set the given option while connected </td></tr>
</table>
</dl>
</div>
</div><p>
<hr>The documentation for this class was generated from the following file:<ul>
<li><a class="el" href="options_8h-source.html">options.h</a></ul>
<hr size="1"><address style="align: right;"><small>Generated on Thu Jun 3 11:59:12 2010 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>
|
