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
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
|
<!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">
</head>
<body>
<!-- Generated by Doxygen 1.8.5 -->
<div id="navrow1" class="tabs">
<ul class="tablist">
<li><a href="index.html"><span>Main Page</span></a></li>
<li><a href="namespaces.html"><span>Namespaces</span></a></li>
<li class="current"><a href="annotated.html"><span>Classes</span></a></li>
<li><a href="files.html"><span>Files</span></a></li>
</ul>
</div>
<div id="navrow2" class="tabs2">
<ul class="tablist">
<li><a href="annotated.html"><span>Class List</span></a></li>
<li><a href="inherits.html"><span>Class Hierarchy</span></a></li>
<li><a href="functions.html"><span>Class Members</span></a></li>
</ul>
</div>
<div id="nav-path" class="navpath">
<ul>
<li class="navelem"><b>mysqlpp</b></li><li class="navelem"><a class="el" href="namespacemysqlpp_1_1examples.html">examples</a></li><li class="navelem"><a class="el" href="classmysqlpp_1_1examples_1_1CommandLine.html">CommandLine</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="summary">
<a href="#pub-methods">Public Member Functions</a> |
<a href="classmysqlpp_1_1examples_1_1CommandLine-members.html">List of all members</a> </div>
<div class="headertitle">
<div class="title">mysqlpp::examples::CommandLine Class Reference</div> </div>
</div><!--header-->
<div class="contents">
<p>Command line parsing mechanism for ../examples/*.cpp.
<a href="classmysqlpp_1_1examples_1_1CommandLine.html#details">More...</a></p>
<p><code>#include <<a class="el" href="cmdline_8h_source.html">cmdline.h</a>></code></p>
<div class="dynheader">
Inheritance diagram for mysqlpp::examples::CommandLine:</div>
<div class="dyncontent">
<div class="center"><img src="classmysqlpp_1_1examples_1_1CommandLine__inherit__graph.png" border="0" usemap="#mysqlpp_1_1examples_1_1CommandLine_inherit__map" alt="Inheritance graph"/></div>
<map name="mysqlpp_1_1examples_1_1CommandLine_inherit__map" id="mysqlpp_1_1examples_1_1CommandLine_inherit__map">
<area shape="rect" id="node2" href="classmysqlpp_1_1CommandLineBase.html" title="Parses command line arguments and holds the results. " alt="" coords="5,5,197,32"/></map>
<center><span class="legend">[<a href="graph_legend.html">legend</a>]</span></center></div>
<div class="dynheader">
Collaboration diagram for mysqlpp::examples::CommandLine:</div>
<div class="dyncontent">
<div class="center"><img src="classmysqlpp_1_1examples_1_1CommandLine__coll__graph.png" border="0" usemap="#mysqlpp_1_1examples_1_1CommandLine_coll__map" alt="Collaboration graph"/></div>
<map name="mysqlpp_1_1examples_1_1CommandLine_coll__map" id="mysqlpp_1_1examples_1_1CommandLine_coll__map">
<area shape="rect" id="node2" href="classmysqlpp_1_1CommandLineBase.html" title="Parses command line arguments and holds the results. " alt="" coords="5,5,197,32"/></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:a94a1168f204e8a945743b533393d0edf"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classmysqlpp_1_1examples_1_1CommandLine.html#a94a1168f204e8a945743b533393d0edf">CommandLine</a> (int argc, char *const argv[], const char *<a class="el" href="classmysqlpp_1_1examples_1_1CommandLine.html#af6e6f19bc3c57061a889f2ddf86bd47c">user</a>=0, const char *<a class="el" href="classmysqlpp_1_1examples_1_1CommandLine.html#a098f5596db403f46a9806659012ddb63">pass</a>=0, const char *usage_extra=0)</td></tr>
<tr class="memdesc:a94a1168f204e8a945743b533393d0edf"><td class="mdescLeft"> </td><td class="mdescRight">Constructor. <a href="#a94a1168f204e8a945743b533393d0edf">More...</a><br/></td></tr>
<tr class="separator:a94a1168f204e8a945743b533393d0edf"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a56c1c6052f38473edd40c97b78b5c4d0"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classmysqlpp_1_1examples_1_1CommandLine.html#a56c1c6052f38473edd40c97b78b5c4d0">print_usage</a> () const </td></tr>
<tr class="memdesc:a56c1c6052f38473edd40c97b78b5c4d0"><td class="mdescLeft"> </td><td class="mdescRight">Show a message explaining the program's proper usage. <a href="#a56c1c6052f38473edd40c97b78b5c4d0">More...</a><br/></td></tr>
<tr class="separator:a56c1c6052f38473edd40c97b78b5c4d0"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a594166a91d9e2f0397e8040874d93c65"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a594166a91d9e2f0397e8040874d93c65"></a>
void </td><td class="memItemRight" valign="bottom"><a class="el" href="classmysqlpp_1_1examples_1_1CommandLine.html#a594166a91d9e2f0397e8040874d93c65">print_usage</a> (const char *extra) const </td></tr>
<tr class="memdesc:a594166a91d9e2f0397e8040874d93c65"><td class="mdescLeft"> </td><td class="mdescRight">Show a message explaining the program's proper usage, with custom extra info after standard command line usage bits. <br/></td></tr>
<tr class="separator:a594166a91d9e2f0397e8040874d93c65"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a7c9518ca1f43caced2360aa273e15d64"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a7c9518ca1f43caced2360aa273e15d64"></a>
bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classmysqlpp_1_1examples_1_1CommandLine.html#a7c9518ca1f43caced2360aa273e15d64">dtest_mode</a> () const </td></tr>
<tr class="memdesc:a7c9518ca1f43caced2360aa273e15d64"><td class="mdescLeft"> </td><td class="mdescRight">Return true if we're in "dtest" mode This happens when an example gets the -D flag, always passed by the dtest script to ask the programs it runs to suppress any nondeterministic output. <br/></td></tr>
<tr class="separator:a7c9518ca1f43caced2360aa273e15d64"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a098f5596db403f46a9806659012ddb63"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a098f5596db403f46a9806659012ddb63"></a>
const char * </td><td class="memItemRight" valign="bottom"><a class="el" href="classmysqlpp_1_1examples_1_1CommandLine.html#a098f5596db403f46a9806659012ddb63">pass</a> () const </td></tr>
<tr class="memdesc:a098f5596db403f46a9806659012ddb63"><td class="mdescLeft"> </td><td class="mdescRight">Return the DB password (-p argument) <br/></td></tr>
<tr class="separator:a098f5596db403f46a9806659012ddb63"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a1ccf6b79127de40132ffed6089c1c60d"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="classmysqlpp_1_1examples_1_1CommandLine.html#a1ccf6b79127de40132ffed6089c1c60d">run_mode</a> () const </td></tr>
<tr class="memdesc:a1ccf6b79127de40132ffed6089c1c60d"><td class="mdescLeft"> </td><td class="mdescRight">Return the -m flag value. <a href="#a1ccf6b79127de40132ffed6089c1c60d">More...</a><br/></td></tr>
<tr class="separator:a1ccf6b79127de40132ffed6089c1c60d"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a5d0713ee8d43f85afdb06568ec391774"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a5d0713ee8d43f85afdb06568ec391774"></a>
const char * </td><td class="memItemRight" valign="bottom"><a class="el" href="classmysqlpp_1_1examples_1_1CommandLine.html#a5d0713ee8d43f85afdb06568ec391774">server</a> () const </td></tr>
<tr class="memdesc:a5d0713ee8d43f85afdb06568ec391774"><td class="mdescLeft"> </td><td class="mdescRight">Return the DB server name (-s argument) <br/></td></tr>
<tr class="separator:a5d0713ee8d43f85afdb06568ec391774"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:af6e6f19bc3c57061a889f2ddf86bd47c"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="af6e6f19bc3c57061a889f2ddf86bd47c"></a>
const char * </td><td class="memItemRight" valign="bottom"><a class="el" href="classmysqlpp_1_1examples_1_1CommandLine.html#af6e6f19bc3c57061a889f2ddf86bd47c">user</a> () const </td></tr>
<tr class="memdesc:af6e6f19bc3c57061a889f2ddf86bd47c"><td class="mdescLeft"> </td><td class="mdescRight">Return the DB user name (-u argument) <br/></td></tr>
<tr class="separator:af6e6f19bc3c57061a889f2ddf86bd47c"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="inherit_header pub_methods_classmysqlpp_1_1CommandLineBase"><td colspan="2" onclick="javascript:toggleInherit('pub_methods_classmysqlpp_1_1CommandLineBase')"><img src="closed.png" alt="-"/> Public Member Functions inherited from <a class="el" href="classmysqlpp_1_1CommandLineBase.html">mysqlpp::CommandLineBase</a></td></tr>
<tr class="memitem:aec314b5214f2eda4482e6597bff686db inherit pub_methods_classmysqlpp_1_1CommandLineBase"><td class="memItemLeft" align="right" valign="top">const <a class="el" href="classmysqlpp_1_1CommandLineBase.html#ae8de28354623bd1541425f512d46b23a">ArgumentList</a> & </td><td class="memItemRight" valign="bottom"><a class="el" href="classmysqlpp_1_1CommandLineBase.html#aec314b5214f2eda4482e6597bff686db">extra_args</a> () const </td></tr>
<tr class="memdesc:aec314b5214f2eda4482e6597bff686db inherit pub_methods_classmysqlpp_1_1CommandLineBase"><td class="mdescLeft"> </td><td class="mdescRight">Get reference to list of command line arguments past the last flag and its possible argument. <a href="#aec314b5214f2eda4482e6597bff686db">More...</a><br/></td></tr>
<tr class="separator:aec314b5214f2eda4482e6597bff686db inherit pub_methods_classmysqlpp_1_1CommandLineBase"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a46519033dcc6913eb3666a099e420707 inherit pub_methods_classmysqlpp_1_1CommandLineBase"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a46519033dcc6913eb3666a099e420707"></a>
 </td><td class="memItemRight" valign="bottom"><a class="el" href="classmysqlpp_1_1CommandLineBase.html#a46519033dcc6913eb3666a099e420707">operator void *</a> () const </td></tr>
<tr class="memdesc:a46519033dcc6913eb3666a099e420707 inherit pub_methods_classmysqlpp_1_1CommandLineBase"><td class="mdescLeft"> </td><td class="mdescRight">Return truthy value if command line was parsed successfully. <br/></td></tr>
<tr class="separator:a46519033dcc6913eb3666a099e420707 inherit pub_methods_classmysqlpp_1_1CommandLineBase"><td class="memSeparator" colspan="2"> </td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="inherited"></a>
Additional Inherited Members</h2></td></tr>
<tr class="inherit_header pub_types_classmysqlpp_1_1CommandLineBase"><td colspan="2" onclick="javascript:toggleInherit('pub_types_classmysqlpp_1_1CommandLineBase')"><img src="closed.png" alt="-"/> Public Types inherited from <a class="el" href="classmysqlpp_1_1CommandLineBase.html">mysqlpp::CommandLineBase</a></td></tr>
<tr class="memitem:ae8de28354623bd1541425f512d46b23a inherit pub_types_classmysqlpp_1_1CommandLineBase"><td class="memItemLeft" align="right" valign="top">typedef std::vector< std::string > </td><td class="memItemRight" valign="bottom"><a class="el" href="classmysqlpp_1_1CommandLineBase.html#ae8de28354623bd1541425f512d46b23a">ArgumentList</a></td></tr>
<tr class="memdesc:ae8de28354623bd1541425f512d46b23a inherit pub_types_classmysqlpp_1_1CommandLineBase"><td class="mdescLeft"> </td><td class="mdescRight">Type for a list of arguments. <a href="#ae8de28354623bd1541425f512d46b23a">More...</a><br/></td></tr>
<tr class="separator:ae8de28354623bd1541425f512d46b23a inherit pub_types_classmysqlpp_1_1CommandLineBase"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a15d9a9ce39ed7da69ece62472905d4c5 inherit pub_types_classmysqlpp_1_1CommandLineBase"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a15d9a9ce39ed7da69ece62472905d4c5"></a>
typedef <br class="typebreak"/>
ArgumentList::const_iterator </td><td class="memItemRight" valign="bottom"><a class="el" href="classmysqlpp_1_1CommandLineBase.html#a15d9a9ce39ed7da69ece62472905d4c5">ArgumentListIt</a></td></tr>
<tr class="memdesc:a15d9a9ce39ed7da69ece62472905d4c5 inherit pub_types_classmysqlpp_1_1CommandLineBase"><td class="mdescLeft"> </td><td class="mdescRight">Iterator into ArgumentList. <br/></td></tr>
<tr class="separator:a15d9a9ce39ed7da69ece62472905d4c5 inherit pub_types_classmysqlpp_1_1CommandLineBase"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="inherit_header pro_methods_classmysqlpp_1_1CommandLineBase"><td colspan="2" onclick="javascript:toggleInherit('pro_methods_classmysqlpp_1_1CommandLineBase')"><img src="closed.png" alt="-"/> Protected Member Functions inherited from <a class="el" href="classmysqlpp_1_1CommandLineBase.html">mysqlpp::CommandLineBase</a></td></tr>
<tr class="memitem:a36aff0ceccfb08be9b04717dc48ac706 inherit pro_methods_classmysqlpp_1_1CommandLineBase"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classmysqlpp_1_1CommandLineBase.html#a36aff0ceccfb08be9b04717dc48ac706">CommandLineBase</a> (int argc, char *const argv[], const char *opts)</td></tr>
<tr class="memdesc:a36aff0ceccfb08be9b04717dc48ac706 inherit pro_methods_classmysqlpp_1_1CommandLineBase"><td class="mdescLeft"> </td><td class="mdescRight">Hidden ctor to prevent instantiation. <a href="#a36aff0ceccfb08be9b04717dc48ac706">More...</a><br/></td></tr>
<tr class="separator:a36aff0ceccfb08be9b04717dc48ac706 inherit pro_methods_classmysqlpp_1_1CommandLineBase"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a70bf4aaf7c80497bd36a51d2a31c87cd inherit pro_methods_classmysqlpp_1_1CommandLineBase"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a70bf4aaf7c80497bd36a51d2a31c87cd"></a>
virtual </td><td class="memItemRight" valign="bottom"><a class="el" href="classmysqlpp_1_1CommandLineBase.html#a70bf4aaf7c80497bd36a51d2a31c87cd">~CommandLineBase</a> ()</td></tr>
<tr class="memdesc:a70bf4aaf7c80497bd36a51d2a31c87cd inherit pro_methods_classmysqlpp_1_1CommandLineBase"><td class="mdescLeft"> </td><td class="mdescRight">Hidden dtor to prevent instantiation. <br/></td></tr>
<tr class="separator:a70bf4aaf7c80497bd36a51d2a31c87cd inherit pro_methods_classmysqlpp_1_1CommandLineBase"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a2351077d0a931ee3ba9738464aaba0c6 inherit pro_methods_classmysqlpp_1_1CommandLineBase"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a2351077d0a931ee3ba9738464aaba0c6"></a>
void </td><td class="memItemRight" valign="bottom"><a class="el" href="classmysqlpp_1_1CommandLineBase.html#a2351077d0a931ee3ba9738464aaba0c6">finish_parse</a> ()</td></tr>
<tr class="memdesc:a2351077d0a931ee3ba9738464aaba0c6 inherit pro_methods_classmysqlpp_1_1CommandLineBase"><td class="mdescLeft"> </td><td class="mdescRight">If object is still marked as "successful", save non-option arguments to extra_args_ list. Subclass ctor should call this after the <a class="el" href="classmysqlpp_1_1CommandLineBase.html#a201bef30e949e6046a8fdc0b76ba4706" title="Wrapper for getopt() ">parse_next()</a> loop gets EOF. <br/></td></tr>
<tr class="separator:a2351077d0a931ee3ba9738464aaba0c6 inherit pro_methods_classmysqlpp_1_1CommandLineBase"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a4a1ab823448b70e726a8d87ad9abecc6 inherit pro_methods_classmysqlpp_1_1CommandLineBase"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a4a1ab823448b70e726a8d87ad9abecc6"></a>
const char * </td><td class="memItemRight" valign="bottom"><a class="el" href="classmysqlpp_1_1CommandLineBase.html#a4a1ab823448b70e726a8d87ad9abecc6">option_argument</a> () const </td></tr>
<tr class="memdesc:a4a1ab823448b70e726a8d87ad9abecc6 inherit pro_methods_classmysqlpp_1_1CommandLineBase"><td class="mdescLeft"> </td><td class="mdescRight">Accessor for getopt()'s optarg global. <br/></td></tr>
<tr class="separator:a4a1ab823448b70e726a8d87ad9abecc6 inherit pro_methods_classmysqlpp_1_1CommandLineBase"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a7448a73de1dd102b85684c47fbfa2b29 inherit pro_methods_classmysqlpp_1_1CommandLineBase"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a7448a73de1dd102b85684c47fbfa2b29"></a>
int </td><td class="memItemRight" valign="bottom"><a class="el" href="classmysqlpp_1_1CommandLineBase.html#a7448a73de1dd102b85684c47fbfa2b29">option_index</a> () const </td></tr>
<tr class="memdesc:a7448a73de1dd102b85684c47fbfa2b29 inherit pro_methods_classmysqlpp_1_1CommandLineBase"><td class="mdescLeft"> </td><td class="mdescRight">Accessor for getopt()'s optind global. <br/></td></tr>
<tr class="separator:a7448a73de1dd102b85684c47fbfa2b29 inherit pro_methods_classmysqlpp_1_1CommandLineBase"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a59476f73810f50528f0c6cc681ab998c inherit pro_methods_classmysqlpp_1_1CommandLineBase"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classmysqlpp_1_1CommandLineBase.html#a59476f73810f50528f0c6cc681ab998c">parse_error</a> (const char *message=0)</td></tr>
<tr class="memdesc:a59476f73810f50528f0c6cc681ab998c inherit pro_methods_classmysqlpp_1_1CommandLineBase"><td class="mdescLeft"> </td><td class="mdescRight">Called by a subclass when encountering a command line parsing error. <a href="#a59476f73810f50528f0c6cc681ab998c">More...</a><br/></td></tr>
<tr class="separator:a59476f73810f50528f0c6cc681ab998c inherit pro_methods_classmysqlpp_1_1CommandLineBase"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a201bef30e949e6046a8fdc0b76ba4706 inherit pro_methods_classmysqlpp_1_1CommandLineBase"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a201bef30e949e6046a8fdc0b76ba4706"></a>
int </td><td class="memItemRight" valign="bottom"><a class="el" href="classmysqlpp_1_1CommandLineBase.html#a201bef30e949e6046a8fdc0b76ba4706">parse_next</a> () const </td></tr>
<tr class="memdesc:a201bef30e949e6046a8fdc0b76ba4706 inherit pro_methods_classmysqlpp_1_1CommandLineBase"><td class="mdescLeft"> </td><td class="mdescRight">Wrapper for getopt() <br/></td></tr>
<tr class="separator:a201bef30e949e6046a8fdc0b76ba4706 inherit pro_methods_classmysqlpp_1_1CommandLineBase"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a97f101de4fb19bb27378bc8522ecf0ca inherit pro_methods_classmysqlpp_1_1CommandLineBase"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a97f101de4fb19bb27378bc8522ecf0ca"></a>
const char * </td><td class="memItemRight" valign="bottom"><a class="el" href="classmysqlpp_1_1CommandLineBase.html#a97f101de4fb19bb27378bc8522ecf0ca">program_name</a> () const </td></tr>
<tr class="memdesc:a97f101de4fb19bb27378bc8522ecf0ca inherit pro_methods_classmysqlpp_1_1CommandLineBase"><td class="mdescLeft"> </td><td class="mdescRight">Get the file name of the program's executable. <br/></td></tr>
<tr class="separator:a97f101de4fb19bb27378bc8522ecf0ca inherit pro_methods_classmysqlpp_1_1CommandLineBase"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:afc505818b7524537dbd7be0aedd0240c inherit pro_methods_classmysqlpp_1_1CommandLineBase"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="afc505818b7524537dbd7be0aedd0240c"></a>
bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classmysqlpp_1_1CommandLineBase.html#afc505818b7524537dbd7be0aedd0240c">successful</a> () const </td></tr>
<tr class="memdesc:afc505818b7524537dbd7be0aedd0240c inherit pro_methods_classmysqlpp_1_1CommandLineBase"><td class="mdescLeft"> </td><td class="mdescRight">Returns true if nothing has gone wrong since calling the ctor. <br/></td></tr>
<tr class="separator:afc505818b7524537dbd7be0aedd0240c inherit pro_methods_classmysqlpp_1_1CommandLineBase"><td class="memSeparator" colspan="2"> </td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p>Command line parsing mechanism for ../examples/*.cpp. </p>
</div><h2 class="groupheader">Constructor & Destructor Documentation</h2>
<a class="anchor" id="a94a1168f204e8a945743b533393d0edf"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">mysqlpp::examples::CommandLine::CommandLine </td>
<td>(</td>
<td class="paramtype">int </td>
<td class="paramname"><em>argc</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">char *const </td>
<td class="paramname"><em>argv</em>[], </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const char * </td>
<td class="paramname"><em>user</em> = <code>0</code>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const char * </td>
<td class="paramname"><em>pass</em> = <code>0</code>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const char * </td>
<td class="paramname"><em>usage_extra</em> = <code>0</code> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Constructor. </p>
<p>Public interface </p>
<p>References <a class="el" href="classmysqlpp_1_1CommandLineBase.html#a2351077d0a931ee3ba9738464aaba0c6">mysqlpp::CommandLineBase::finish_parse()</a>, <a class="el" href="classmysqlpp_1_1CommandLineBase.html#a4a1ab823448b70e726a8d87ad9abecc6">mysqlpp::CommandLineBase::option_argument()</a>, <a class="el" href="classmysqlpp_1_1CommandLineBase.html#a59476f73810f50528f0c6cc681ab998c">mysqlpp::CommandLineBase::parse_error()</a>, <a class="el" href="classmysqlpp_1_1CommandLineBase.html#a201bef30e949e6046a8fdc0b76ba4706">mysqlpp::CommandLineBase::parse_next()</a>, and <a class="el" href="classmysqlpp_1_1CommandLineBase.html#afc505818b7524537dbd7be0aedd0240c">mysqlpp::CommandLineBase::successful()</a>.</p>
</div>
</div>
<h2 class="groupheader">Member Function Documentation</h2>
<a class="anchor" id="a56c1c6052f38473edd40c97b78b5c4d0"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">void mysqlpp::examples::CommandLine::print_usage </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Show a message explaining the program's proper usage. </p>
<p>Calls print_usage(const char*), passing along the "usage_extra" parameter passed to the ctor </p>
<p>Implements <a class="el" href="classmysqlpp_1_1CommandLineBase.html#a5d620f5e364c55c813254aad693b08ec">mysqlpp::CommandLineBase</a>.</p>
<p>References <a class="el" href="classmysqlpp_1_1examples_1_1CommandLine.html#a56c1c6052f38473edd40c97b78b5c4d0">print_usage()</a>.</p>
<p>Referenced by <a class="el" href="classmysqlpp_1_1examples_1_1CommandLine.html#a56c1c6052f38473edd40c97b78b5c4d0">print_usage()</a>.</p>
</div>
</div>
<a class="anchor" id="a1ccf6b79127de40132ffed6089c1c60d"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">int mysqlpp::examples::CommandLine::run_mode </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const</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>Return the -m flag value. </p>
<p>This flag is currently only used by examples/deadlock, but it's really a nonspecific "mode" value, which could be used by other examples in the future. </p>
</div>
</div>
<hr/>The documentation for this class was generated from the following files:<ul>
<li><a class="el" href="cmdline_8h_source.html">cmdline.h</a></li>
<li>cmdline.cpp</li>
</ul>
</div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated on Wed Mar 18 2015 18:55:03 for MySQL++ by  <a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/>
</a> 1.8.5
</small></address>
</body>
</html>
|
