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++: mysqlpp::Option Class 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="classmysqlpp_1_1Option.html">Option</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="summary">
<a href="#pub-types">Public Types</a> |
<a href="#pub-methods">Public Member Functions</a> |
<a href="classmysqlpp_1_1Option-members.html">List of all members</a> </div>
<div class="headertitle">
<div class="title">mysqlpp::Option Class Reference<span class="mlabels"><span class="mlabel">abstract</span></span></div> </div>
</div><!--header-->
<div class="contents">
<p>Define abstract interface for all *Option subclasses.
<a href="classmysqlpp_1_1Option.html#details">More...</a></p>
<p><code>#include <<a class="el" href="options_8h_source.html">options.h</a>></code></p>
<div class="dynheader">
Inheritance diagram for mysqlpp::Option:</div>
<div class="dyncontent">
<div class="center"><img src="classmysqlpp_1_1Option__inherit__graph.png" border="0" usemap="#mysqlpp_1_1Option_inherit__map" alt="Inheritance graph"/></div>
<map name="mysqlpp_1_1Option_inherit__map" id="mysqlpp_1_1Option_inherit__map">
<area shape="rect" title="Define abstract interface for all *Option subclasses." alt="" coords="5,737,123,763"/>
<area shape="rect" href="classmysqlpp_1_1CompressOption.html" title="Enable data compression on the connection." alt="" coords="199,576,377,601"/>
<area shape="rect" href="classmysqlpp_1_1DataOption.html" title="Define abstract interface for all *Options that take a lone scalar as an argument." alt="" coords="200,625,376,651"/>
<area shape="rect" href="classmysqlpp_1_1GuessConnectionOption.html" title="Allow C API to guess what kind of connection to use." alt="" coords="196,675,380,713"/>
<area shape="rect" href="classmysqlpp_1_1NamedPipeOption.html" title="Suggest use of named pipes." alt="" coords="194,737,382,763"/>
<area shape="rect" href="classmysqlpp_1_1SslOption.html" title="Specialized option for handling SSL parameters." alt="" coords="220,787,356,812"/>
<area shape="rect" href="classmysqlpp_1_1UseEmbeddedConnectionOption.html" title="Connect to embedded server in preference to remote server." alt="" coords="171,836,405,875"/>
<area shape="rect" href="classmysqlpp_1_1UseRemoteConnectionOption.html" title="Connect to remote server in preference to embedded server." alt="" coords="180,899,396,937"/>
<area shape="rect" href="classmysqlpp_1_1ConnectTimeoutOption.html" title="Change Connection::connect() default timeout." alt="" coords="456,5,671,44"/>
<area shape="rect" href="classmysqlpp_1_1FoundRowsOption.html" title="Make Query::affected_rows() return number of matched rows." alt="" coords="469,68,657,107"/>
<area shape="rect" href="classmysqlpp_1_1IgnoreSpaceOption.html" title="Allow spaces after function names in queries." alt="" coords="466,131,660,169"/>
<area shape="rect" href="classmysqlpp_1_1InitCommandOption.html" title="Give SQL executed on connect." alt="" coords="465,193,662,219"/>
<area shape="rect" href="classmysqlpp_1_1InteractiveOption.html" title="Assert that this is an interactive program." alt="" coords="473,243,653,281"/>
<area shape="rect" href="classmysqlpp_1_1LocalFilesOption.html" title="Enable LOAD DATA LOCAL statement." alt="" coords="474,305,652,344"/>
<area shape="rect" href="classmysqlpp_1_1LocalInfileOption.html" title="Enable LOAD LOCAL INFILE statement." alt="" coords="474,368,652,407"/>
<area shape="rect" href="classmysqlpp_1_1MultiResultsOption.html" title="Enable multiple result sets in a reply." alt="" coords="468,431,658,469"/>
<area shape="rect" href="classmysqlpp_1_1MultiStatementsOption.html" title="Enable multiple queries in a request to the server." alt="" coords="476,493,650,532"/>
<area shape="rect" href="classmysqlpp_1_1NoSchemaOption.html" title="Disable db.tbl.col syntax in queries." alt="" coords="471,556,655,595"/>
<area shape="rect" href="classmysqlpp_1_1ReadDefaultFileOption.html" title="Override use of my.cnf." alt="" coords="476,619,650,657"/>
<area shape="rect" href="classmysqlpp_1_1ReadDefaultGroupOption.html" title="Override use of my.cnf." alt="" coords="468,681,658,720"/>
<area shape="rect" href="classmysqlpp_1_1ReadTimeoutOption.html" title="Set timeout for IPC data reads." alt="" coords="464,744,662,783"/>
<area shape="rect" href="classmysqlpp_1_1ReconnectOption.html" title="Enable automatic reconnection to server." alt="" coords="472,807,654,845"/>
<area shape="rect" href="classmysqlpp_1_1ReportDataTruncationOption.html" title="Set reporting of data truncation errors." alt="" coords="458,869,668,908"/>
<area shape="rect" href="classmysqlpp_1_1SecureAuthOption.html" title="Enforce use of secure authentication, refusing connection if not available." alt="" coords="469,932,657,971"/>
<area shape="rect" href="classmysqlpp_1_1SetCharsetDirOption.html" title="Give path to charset definition files." alt="" coords="462,995,664,1020"/>
<area shape="rect" href="classmysqlpp_1_1SetCharsetNameOption.html" title="Give name of default charset." alt="" coords="453,1044,673,1069"/>
<area shape="rect" href="classmysqlpp_1_1SetClientIpOption.html" title="Fake client IP address when connecting to embedded server." alt="" coords="472,1093,654,1119"/>
<area shape="rect" href="classmysqlpp_1_1SharedMemoryBaseNameOption.html" title="Set name of shmem segment for IPC." alt="" coords="463,1143,663,1181"/>
<area shape="rect" href="classmysqlpp_1_1WriteTimeoutOption.html" title="Set timeout for IPC data reads." alt="" coords="465,1205,661,1244"/>
</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-types"></a>
Public Types</h2></td></tr>
<tr class="memitem:af0c0e22b32d2ee489bc77d360ce74c8c"><td class="memItemLeft" align="right" valign="top">enum  </td><td class="memItemRight" valign="bottom"><a class="el" href="classmysqlpp_1_1Option.html#af0c0e22b32d2ee489bc77d360ce74c8c">Error</a> { <br />
  <a class="el" href="classmysqlpp_1_1Option.html#af0c0e22b32d2ee489bc77d360ce74c8ca428c375eef3714cefac2c2c10396c14c">err_NONE</a>,
<a class="el" href="classmysqlpp_1_1Option.html#af0c0e22b32d2ee489bc77d360ce74c8ca8006fc8212a2393a084f26d7980b8707">err_api_limit</a>,
<a class="el" href="classmysqlpp_1_1Option.html#af0c0e22b32d2ee489bc77d360ce74c8ca3b6c862bd1548d5f4c28b62df8e600c6">err_api_reject</a>,
<a class="el" href="classmysqlpp_1_1Option.html#af0c0e22b32d2ee489bc77d360ce74c8cab6ee57a202c62afb4f66912137174973">err_connected</a>,
<br />
  <a class="el" href="classmysqlpp_1_1Option.html#af0c0e22b32d2ee489bc77d360ce74c8ca6d200a37429e238707384de5826cd270">err_disconnected</a>
<br />
}</td></tr>
<tr class="memdesc:af0c0e22b32d2ee489bc77d360ce74c8c"><td class="mdescLeft"> </td><td class="mdescRight">Types of option setting errors we can diagnose. <a href="classmysqlpp_1_1Option.html#af0c0e22b32d2ee489bc77d360ce74c8c">More...</a><br /></td></tr>
<tr class="separator:af0c0e22b32d2ee489bc77d360ce74c8c"><td class="memSeparator" colspan="2"> </td></tr>
</table><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:acf6f7585df2f41324516e45ad4856899"><td class="memItemLeft" align="right" valign="top"><a id="acf6f7585df2f41324516e45ad4856899"></a>
virtual </td><td class="memItemRight" valign="bottom"><a class="el" href="classmysqlpp_1_1Option.html#acf6f7585df2f41324516e45ad4856899">~Option</a> ()</td></tr>
<tr class="memdesc:acf6f7585df2f41324516e45ad4856899"><td class="mdescLeft"> </td><td class="mdescRight">Destroy object. <br /></td></tr>
<tr class="separator:acf6f7585df2f41324516e45ad4856899"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ab783846ebf48b7c7319cc045cb0b1828"><td class="memItemLeft" align="right" valign="top"><a id="ab783846ebf48b7c7319cc045cb0b1828"></a>
virtual <a class="el" href="classmysqlpp_1_1Option.html#af0c0e22b32d2ee489bc77d360ce74c8c">Error</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classmysqlpp_1_1Option.html#ab783846ebf48b7c7319cc045cb0b1828">set</a> (<a class="el" href="classmysqlpp_1_1DBDriver.html">DBDriver</a> *dbd)=0</td></tr>
<tr class="memdesc:ab783846ebf48b7c7319cc045cb0b1828"><td class="mdescLeft"> </td><td class="mdescRight">Apply option. <br /></td></tr>
<tr class="separator:ab783846ebf48b7c7319cc045cb0b1828"><td class="memSeparator" colspan="2"> </td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p>Define abstract interface for all *Option subclasses. </p>
<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>
</div><h2 class="groupheader">Member Enumeration Documentation</h2>
<a id="af0c0e22b32d2ee489bc77d360ce74c8c"></a>
<h2 class="memtitle"><span class="permalink"><a href="#af0c0e22b32d2ee489bc77d360ce74c8c">◆ </a></span>Error</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">enum <a class="el" href="classmysqlpp_1_1Option.html#af0c0e22b32d2ee489bc77d360ce74c8c">mysqlpp::Option::Error</a></td>
</tr>
</table>
</div><div class="memdoc">
<p>Types of option setting errors we can diagnose. </p>
<table class="fieldtable">
<tr><th colspan="2">Enumerator</th></tr><tr><td class="fieldname"><a id="af0c0e22b32d2ee489bc77d360ce74c8ca428c375eef3714cefac2c2c10396c14c"></a>err_NONE </td><td class="fielddoc"><p>option was set successfully </p>
</td></tr>
<tr><td class="fieldname"><a id="af0c0e22b32d2ee489bc77d360ce74c8ca8006fc8212a2393a084f26d7980b8707"></a>err_api_limit </td><td class="fielddoc"><p>option not supported by underlying C API </p>
</td></tr>
<tr><td class="fieldname"><a id="af0c0e22b32d2ee489bc77d360ce74c8ca3b6c862bd1548d5f4c28b62df8e600c6"></a>err_api_reject </td><td class="fielddoc"><p>underlying C API returned error when setting option </p>
</td></tr>
<tr><td class="fieldname"><a id="af0c0e22b32d2ee489bc77d360ce74c8cab6ee57a202c62afb4f66912137174973"></a>err_connected </td><td class="fielddoc"><p>can't set the given option while connected </p>
</td></tr>
<tr><td class="fieldname"><a id="af0c0e22b32d2ee489bc77d360ce74c8ca6d200a37429e238707384de5826cd270"></a>err_disconnected </td><td class="fielddoc"><p>can only set the given option while connected </p>
</td></tr>
</table>
</div>
</div>
<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></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>
|
