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
|
<!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_1WindowsNamedPipeConnection.html">WindowsNamedPipeConnection</a></div>
<h1>mysqlpp::WindowsNamedPipeConnection Class Reference</h1><!-- doxytag: class="mysqlpp::WindowsNamedPipeConnection" --><!-- doxytag: inherits="mysqlpp::Connection" -->Specialization of <code><a class="el" href="classmysqlpp_1_1Connection.html">Connection</a></code> for Windows named pipes.
<a href="#_details">More...</a>
<p>
<code>#include <<a class="el" href="wnp__connection_8h-source.html">wnp_connection.h</a>></code>
<p>
Inheritance diagram for mysqlpp::WindowsNamedPipeConnection:<p><center><img src="classmysqlpp_1_1WindowsNamedPipeConnection__inherit__graph.png" border="0" usemap="#mysqlpp_1_1WindowsNamedPipeConnection__inherit__map" alt="Inheritance graph"></center>
<map name="mysqlpp_1_1WindowsNamedPipeConnection__inherit__map">
<area href="classmysqlpp_1_1Connection.html" shape="rect" coords="72,81,232,105" alt="">
<area href="classmysqlpp_1_1OptionalExceptions.html" shape="rect" coords="45,7,259,31" alt="">
</map>
<center><font size="2">[<a href="graph_legend.html">legend</a>]</font></center>Collaboration diagram for mysqlpp::WindowsNamedPipeConnection:<p><center><img src="classmysqlpp_1_1WindowsNamedPipeConnection__coll__graph.png" border="0" usemap="#mysqlpp_1_1WindowsNamedPipeConnection__coll__map" alt="Collaboration graph"></center>
<map name="mysqlpp_1_1WindowsNamedPipeConnection__coll__map">
<area href="classmysqlpp_1_1Connection.html" shape="rect" coords="192,97,352,121" alt="">
<area href="classmysqlpp_1_1OptionalExceptions.html" shape="rect" coords="5,7,219,31" alt="">
<area href="classmysqlpp_1_1DBDriver.html" shape="rect" coords="333,7,480,31" alt="">
</map>
<center><font size="2">[<a href="graph_legend.html">legend</a>]</font></center><a href="classmysqlpp_1_1WindowsNamedPipeConnection-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="8f144565e1f5c82783b923529c791944"></a><!-- doxytag: member="mysqlpp::WindowsNamedPipeConnection::WindowsNamedPipeConnection" ref="8f144565e1f5c82783b923529c791944" args="()" -->
</td><td class="memItemRight" valign="bottom"><a class="el" href="classmysqlpp_1_1WindowsNamedPipeConnection.html#8f144565e1f5c82783b923529c791944">WindowsNamedPipeConnection</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Create object without connecting it to the MySQL server. <br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classmysqlpp_1_1WindowsNamedPipeConnection.html#aa7a945b918efe54b095d52a472153fc">WindowsNamedPipeConnection</a> (const char *db, const char *user=0, const char *password=0)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Create object and connect to database server over Windows named pipes in one step. <a href="#aa7a945b918efe54b095d52a472153fc"></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_1WindowsNamedPipeConnection.html#c9fe1d6a34624327ed811ad9a4e960e6">WindowsNamedPipeConnection</a> (const <a class="el" href="classmysqlpp_1_1WindowsNamedPipeConnection.html">WindowsNamedPipeConnection</a> &other)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Establish a new connection using the same parameters as an existing connection. <a href="#c9fe1d6a34624327ed811ad9a4e960e6"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="9827c3ca18e60f6a8b0f6b333170531f"></a><!-- doxytag: member="mysqlpp::WindowsNamedPipeConnection::~WindowsNamedPipeConnection" ref="9827c3ca18e60f6a8b0f6b333170531f" args="()" -->
</td><td class="memItemRight" valign="bottom"><a class="el" href="classmysqlpp_1_1WindowsNamedPipeConnection.html#9827c3ca18e60f6a8b0f6b333170531f">~WindowsNamedPipeConnection</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">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classmysqlpp_1_1WindowsNamedPipeConnection.html#7cf8d2f55b38508d5a16120bf21e7a3c">connect</a> (const char *db=0, const char *user=0, const char *password=0)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Connect to database after object is created. <a href="#7cf8d2f55b38508d5a16120bf21e7a3c"></a><br></td></tr>
<tr><td colspan="2"><br><h2>Static Public Member Functions</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">static bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classmysqlpp_1_1WindowsNamedPipeConnection.html#d514b534112ad0477325af6ff4c41080">is_wnp</a> (const char *server)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Check that given string denotes a Windows named pipe connection to MySQL. <a href="#d514b534112ad0477325af6ff4c41080"></a><br></td></tr>
</table>
<hr><a name="_details"></a><h2>Detailed Description</h2>
Specialization of <code><a class="el" href="classmysqlpp_1_1Connection.html">Connection</a></code> for Windows named pipes.
<p>
This class just simplifies the connection creation interface of <code><a class="el" href="classmysqlpp_1_1Connection.html">Connection</a></code>. It does not add new functionality.
<p>
<hr><h2>Constructor & Destructor Documentation</h2>
<a class="anchor" name="aa7a945b918efe54b095d52a472153fc"></a><!-- doxytag: member="mysqlpp::WindowsNamedPipeConnection::WindowsNamedPipeConnection" ref="aa7a945b918efe54b095d52a472153fc" args="(const char *db, const char *user=0, const char *password=0)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">mysqlpp::WindowsNamedPipeConnection::WindowsNamedPipeConnection </td>
<td>(</td>
<td class="paramtype">const char * </td>
<td class="paramname"> <em>db</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>password</em> = <code>0</code></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td width="100%"><code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Create object and connect to database server over Windows named pipes in one step.
<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>db</em> </td><td>name of database to use </td></tr>
<tr><td valign="top"></td><td valign="top"><em>user</em> </td><td>user name to log in under, or 0 to use the user name the program is running under </td></tr>
<tr><td valign="top"></td><td valign="top"><em>password</em> </td><td>password to use when logging in </td></tr>
</table>
</dl>
</div>
</div><p>
<a class="anchor" name="c9fe1d6a34624327ed811ad9a4e960e6"></a><!-- doxytag: member="mysqlpp::WindowsNamedPipeConnection::WindowsNamedPipeConnection" ref="c9fe1d6a34624327ed811ad9a4e960e6" args="(const WindowsNamedPipeConnection &other)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">mysqlpp::WindowsNamedPipeConnection::WindowsNamedPipeConnection </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classmysqlpp_1_1WindowsNamedPipeConnection.html">WindowsNamedPipeConnection</a> & </td>
<td class="paramname"> <em>other</em> </td>
<td> ) </td>
<td width="100%"><code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Establish a new connection using the same parameters as an existing connection.
<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>other</em> </td><td>pre-existing connection to clone </td></tr>
</table>
</dl>
</div>
</div><p>
<hr><h2>Member Function Documentation</h2>
<a class="anchor" name="7cf8d2f55b38508d5a16120bf21e7a3c"></a><!-- doxytag: member="mysqlpp::WindowsNamedPipeConnection::connect" ref="7cf8d2f55b38508d5a16120bf21e7a3c" args="(const char *db=0, const char *user=0, const char *password=0)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool mysqlpp::WindowsNamedPipeConnection::connect </td>
<td>(</td>
<td class="paramtype">const char * </td>
<td class="paramname"> <em>db</em> = <code>0</code>, </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>password</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>
Connect to database after object is created.
<p>
It's better to use the connect-on-create constructor if you can. See its documentation for the meaning of these parameters.<p>
If you call this method on an object that is already connected to a database server, the previous connection is dropped and a new connection is established.
</div>
</div><p>
<a class="anchor" name="d514b534112ad0477325af6ff4c41080"></a><!-- doxytag: member="mysqlpp::WindowsNamedPipeConnection::is_wnp" ref="d514b534112ad0477325af6ff4c41080" args="(const char *server)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool mysqlpp::WindowsNamedPipeConnection::is_wnp </td>
<td>(</td>
<td class="paramtype">const char * </td>
<td class="paramname"> <em>server</em> </td>
<td> ) </td>
<td width="100%"><code> [static]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Check that given string denotes a Windows named pipe connection to MySQL.
<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>server</em> </td><td>the server address</td></tr>
</table>
</dl>
<dl compact><dt><b>Returns:</b></dt><dd>false if server address does not denote a Windows named pipe connection, or we are not running on Windows </dd></dl>
</div>
</div><p>
<hr>The documentation for this class was generated from the following files:<ul>
<li><a class="el" href="wnp__connection_8h-source.html">wnp_connection.h</a><li>wnp_connection.cpp</ul>
<hr size="1"><address style="align: right;"><small>Generated on Fri Feb 29 16:26:52 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>
|