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
|
<!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="namespacemysqlpp_1_1examples.html">examples</a>::<a class="el" href="classmysqlpp_1_1examples_1_1CommandLine.html">CommandLine</a></div>
<h1>mysqlpp::examples::CommandLine Class Reference</h1><!-- doxytag: class="mysqlpp::examples::CommandLine" --><!-- doxytag: inherits="mysqlpp::CommandLineBase" -->Command line parsing mechanism for ../examples/*.cpp.
<a href="#_details">More...</a>
<p>
<code>#include <<a class="el" href="cmdline_8h-source.html">cmdline.h</a>></code>
<p>
Inheritance diagram for mysqlpp::examples::CommandLine:<p><center><img src="classmysqlpp_1_1examples_1_1CommandLine__inherit__graph.png" border="0" usemap="#mysqlpp_1_1examples_1_1CommandLine__inherit__map" alt="Inheritance graph"></center>
<map name="mysqlpp_1_1examples_1_1CommandLine__inherit__map">
<area href="classmysqlpp_1_1CommandLineBase.html" shape="rect" coords="25,7,239,31" alt="">
</map>
<center><font size="2">[<a href="graph_legend.html">legend</a>]</font></center>Collaboration diagram for mysqlpp::examples::CommandLine:<p><center><img src="classmysqlpp_1_1examples_1_1CommandLine__coll__graph.png" border="0" usemap="#mysqlpp_1_1examples_1_1CommandLine__coll__map" alt="Collaboration graph"></center>
<map name="mysqlpp_1_1examples_1_1CommandLine__coll__map">
<area href="classmysqlpp_1_1CommandLineBase.html" shape="rect" coords="25,7,239,31" alt="">
</map>
<center><font size="2">[<a href="graph_legend.html">legend</a>]</font></center><a href="classmysqlpp_1_1examples_1_1CommandLine-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"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classmysqlpp_1_1examples_1_1CommandLine.html#94a1168f204e8a945743b533393d0edf">CommandLine</a> (int argc, char *const argv[], const char *user=0, const char *pass=0, const char *usage_extra=0)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Constructor. <a href="#94a1168f204e8a945743b533393d0edf"></a><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_1examples_1_1CommandLine.html#56c1c6052f38473edd40c97b78b5c4d0">print_usage</a> () const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Show a message explaining the program's proper usage. <a href="#56c1c6052f38473edd40c97b78b5c4d0"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="594166a91d9e2f0397e8040874d93c65"></a><!-- doxytag: member="mysqlpp::examples::CommandLine::print_usage" ref="594166a91d9e2f0397e8040874d93c65" args="(const char *extra) const " -->
void </td><td class="memItemRight" valign="bottom"><a class="el" href="classmysqlpp_1_1examples_1_1CommandLine.html#594166a91d9e2f0397e8040874d93c65">print_usage</a> (const char *extra) const </td></tr>
<tr><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><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="7c9518ca1f43caced2360aa273e15d64"></a><!-- doxytag: member="mysqlpp::examples::CommandLine::dtest_mode" ref="7c9518ca1f43caced2360aa273e15d64" args="() const " -->
bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classmysqlpp_1_1examples_1_1CommandLine.html#7c9518ca1f43caced2360aa273e15d64">dtest_mode</a> () const </td></tr>
<tr><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><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="098f5596db403f46a9806659012ddb63"></a><!-- doxytag: member="mysqlpp::examples::CommandLine::pass" ref="098f5596db403f46a9806659012ddb63" args="() const " -->
const char * </td><td class="memItemRight" valign="bottom"><a class="el" href="classmysqlpp_1_1examples_1_1CommandLine.html#098f5596db403f46a9806659012ddb63">pass</a> () const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Return the DB password (-p argument). <br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="classmysqlpp_1_1examples_1_1CommandLine.html#1ccf6b79127de40132ffed6089c1c60d">run_mode</a> () const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Return the -m flag value. <a href="#1ccf6b79127de40132ffed6089c1c60d"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="5d0713ee8d43f85afdb06568ec391774"></a><!-- doxytag: member="mysqlpp::examples::CommandLine::server" ref="5d0713ee8d43f85afdb06568ec391774" args="() const " -->
const char * </td><td class="memItemRight" valign="bottom"><a class="el" href="classmysqlpp_1_1examples_1_1CommandLine.html#5d0713ee8d43f85afdb06568ec391774">server</a> () const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Return the DB server name (-s argument). <br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="f6e6f19bc3c57061a889f2ddf86bd47c"></a><!-- doxytag: member="mysqlpp::examples::CommandLine::user" ref="f6e6f19bc3c57061a889f2ddf86bd47c" args="() const " -->
const char * </td><td class="memItemRight" valign="bottom"><a class="el" href="classmysqlpp_1_1examples_1_1CommandLine.html#f6e6f19bc3c57061a889f2ddf86bd47c">user</a> () const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Return the DB user name (-u argument). <br></td></tr>
</table>
<hr><a name="_details"></a><h2>Detailed Description</h2>
Command line parsing mechanism for ../examples/*.cpp.
<p>
<hr><h2>Constructor & Destructor Documentation</h2>
<a class="anchor" name="94a1168f204e8a945743b533393d0edf"></a><!-- doxytag: member="mysqlpp::examples::CommandLine::CommandLine" ref="94a1168f204e8a945743b533393d0edf" args="(int argc, char *const argv[], const char *user=0, const char *pass=0, const char *usage_extra=0)" -->
<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><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td width="100%"></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Constructor.
<p>
Public interface
</div>
</div><p>
<hr><h2>Member Function Documentation</h2>
<a class="anchor" name="56c1c6052f38473edd40c97b78b5c4d0"></a><!-- doxytag: member="mysqlpp::examples::CommandLine::print_usage" ref="56c1c6052f38473edd40c97b78b5c4d0" args="() const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void mysqlpp::examples::CommandLine::print_usage </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td width="100%"> const<code> [inline, virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Show a message explaining the program's proper usage.
<p>
Calls print_usage(const char*), passing along the "usage_extra" parameter passed to the ctor
<p>
Implements <a class="el" href="classmysqlpp_1_1CommandLineBase.html#5d620f5e364c55c813254aad693b08ec">mysqlpp::CommandLineBase</a>.
</div>
</div><p>
<a class="anchor" name="1ccf6b79127de40132ffed6089c1c60d"></a><!-- doxytag: member="mysqlpp::examples::CommandLine::run_mode" ref="1ccf6b79127de40132ffed6089c1c60d" args="() const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int mysqlpp::examples::CommandLine::run_mode </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 -m flag value.
<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.
</div>
</div><p>
<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>cmdline.cpp</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>
|
