Source of: /manual/en/function.mysql-get-host-info.php
<?php
include_once $_SERVER['DOCUMENT_ROOT'] . '/include/shared-manual.inc';
$TOC = array();
$PARENTS = array();
include_once dirname(__FILE__) ."/toc/ref.mysql.inc";
$setup = array (
'home' =>
array (
0 => 'index.php',
1 => 'PHP Manual',
),
'head' =>
array (
0 => 'UTF-8',
1 => 'en',
),
'this' =>
array (
0 => 'function.mysql-get-host-info.php',
1 => 'mysql_get_host_info',
),
'up' =>
array (
0 => 'ref.mysql.php',
1 => 'MySQL Functions',
),
'prev' =>
array (
0 => 'function.mysql-get-client-info.php',
1 => 'mysql_get_client_info',
),
'next' =>
array (
0 => 'function.mysql-get-proto-info.php',
1 => 'mysql_get_proto_info',
),
);
$setup["toc"] = $TOC;
$setup["parents"] = $PARENTS;
manual_setup($setup);
manual_header();
?>
<div id="function.mysql-get-host-info" class="refentry">
<div class="refnamediv">
<h1 class="refname">mysql_get_host_info</h1>
<p class="verinfo">(PHP 4 >= 4.0.5, PHP 5)</p><p class="refpurpose"><span class="refname">mysql_get_host_info</span> — <span class="dc-title">Get MySQL host info</span></p>
</div>
<a name="function.mysql-get-host-info.description"></a><div class="refsect1 description">
<h3 class="title">Description</h3>
<div class="methodsynopsis dc-description">
<span class="type">string</span> <span class="methodname"><b>mysql_get_host_info</b></span>
([ <span class="methodparam"><span class="type">resource</span> <tt class="parameter">$link_identifier</tt></span>
] )</div>
<p class="para rdfs-comment">
Describes the type of connection in use for the connection, including the
server host name.
</p>
</div>
<a name="function.mysql-get-host-info.parameters"></a><div class="refsect1 parameters">
<h3 class="title">Parameters</h3>
<p class="para">
</p><dl>
<dt class="varlistentry">
<span class="term"><i><tt class="parameter">
link_identifier</tt></i>
</span>
</dt><dd class="listitem">
<p class="para">The MySQL connection. If the
link identifier is not specified, the last link opened by
<a href="function.mysql-connect.php" class="function">mysql_connect()</a> is assumed. If no such link is found, it
will try to create one as if <a href="function.mysql-connect.php" class="function">mysql_connect()</a> was called
with no arguments. If no connection is found or established, an
<b><tt class="constant">E_WARNING</tt></b> level error is generated.</p></dd>
</dl>
<p>
</p>
</div>
<a name="function.mysql-get-host-info.returnvalues"></a><div class="refsect1 returnvalues">
<h3 class="title">Return Values</h3>
<p class="para">
Returns a string describing the type of MySQL connection in use for the
connection or <b><tt class="constant">FALSE</tt></b> on failure.
</p>
</div>
<a name="function.mysql-get-host-info.examples"></a><div class="refsect1 examples">
<h3 class="title">Examples</h3>
<p class="para">
</p><div class="example">
<p><b>Example #1 <b>mysql_get_host_info()</b> example</b></p>
<div class="example-contents programlisting">
<div class="phpcode"><code><span style="color: #000000">
<span style="color: #0000BB"><?php<br />$link </span><span style="color: #007700">= </span><span style="color: #0000BB">mysql_connect</span><span style="color: #007700">(</span><span style="color: #DD0000">'localhost'</span><span style="color: #007700">, </span><span style="color: #DD0000">'mysql_user'</span><span style="color: #007700">, </span><span style="color: #DD0000">'mysql_password'</span><span style="color: #007700">);<br />if (!</span><span style="color: #0000BB">$link</span><span style="color: #007700">) {<br /> die(</span><span style="color: #DD0000">'Could not connect: ' </span><span style="color: #007700">. </span><span style="color: #0000BB">mysql_error</span><span style="color: #007700">());<br />}<br /></span><span style="color: #0000BB">printf</span><span style="color: #007700">(</span><span style="color: #DD0000">"MySQL host info: %s\n"</span><span style="color: #007700">, </span><span style="color: #0000BB">mysql_get_host_info</span><span style="color: #007700">());<br /></span><span style="color: #0000BB">?></span>
</span>
</code></div>
</div>
<div class="example-contents para"><p>The above example will output
something similar to:</p></div>
<div class="example-contents screen">
<div class="cdata"><pre>
MySQL host info: Localhost via UNIX socket
</pre></div>
</div>
</div><p>
</p>
</div>
<a name="function.mysql-get-host-info.seealso"></a><div class="refsect1 seealso">
<h3 class="title">See Also</h3>
<p class="para">
</p><ul class="simplelist">
<li class="member"><a href="function.mysql-get-client-info.php" class="function" rel="rdfs-seeAlso">mysql_get_client_info()</a> - Get MySQL client info</li>
<li class="member"><a href="function.mysql-get-proto-info.php" class="function" rel="rdfs-seeAlso">mysql_get_proto_info()</a> - Get MySQL protocol info</li>
<li class="member"><a href="function.mysql-get-server-info.php" class="function" rel="rdfs-seeAlso">mysql_get_server_info()</a> - Get MySQL server info</li>
</ul><p>
</p>
</div>
</div><?php manual_footer(); ?>
