<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.6 $ -->
  <refentry id="function.mysqli-get-host-info">
   <refnamediv>
    <refname>mysqli_get_host_info</refname>
    <refname>mysqli->get_host_info</refname>
    <refpurpose>Returns a string representing the type of connection used</refpurpose>
   </refnamediv>
   <refsect1>
    <title>Description</title>
    <para>Procdural style:</para>
    <methodsynopsis>
     <type>string</type><methodname>mysqli_get_host_info</methodname>
     <methodparam><type>object</type><parameter>link</parameter></methodparam>
    </methodsynopsis>
    <para>Object oriented style (property):</para>
    <classsynopsis>
     <ooclass><classname>mysqli</classname></ooclass>
     <fieldsynopsis><type>string</type><varname>host_info</varname></fieldsynopsis>
    </classsynopsis>
    <para>
     The <function>mysqli_get_host_info</function> function returns a string
     describing the connection represented by the <parameter>link</parameter>
     parameter is using (including the server host name).
    </para>
   </refsect1>
   <refsect1>
    &reftitle.returnvalues;
    <para>
     A character string representing the server hostname and the connection type.  
    </para>
   </refsect1>
   <refsect1>
    <title>See also</title> 
    <para>
     <function>mysqli_get_proto_info</function>
    </para>
   </refsect1>
   <refsect1>
    <title>Example</title>
    <example>
     <title>Object oriented style</title>
     <programlisting role="php">
<![CDATA[
<?php
$mysqli = new mysqli("localhost", "my_user", "my_password", "world");

/* check connection */
if (mysqli_connect_errno()) {
    printf("Connect failed: %s\n", mysqli_connect_error());
    exit();
}

/* print host information */
printf("Host info: %s\n", $mysqli->host_info);

/* close connection */
$mysqli->close();
?>
]]>
    </programlisting>
    </example>
    <example>
     <title>Procedural style</title>
     <programlisting role="php">
<![CDATA[
<?php
$link = mysqli_connect("localhost", "my_user", "my_password", "world");

/* check connection */
if (mysqli_connect_errno()) {
    printf("Connect failed: %s\n", mysqli_connect_error());
    exit();
}

/* print host information */
printf("Host info: %s\n", mysqli_get_host_info($link));

/* close connection */
mysqli_close($link);
?>
]]>
     </programlisting>
    </example>
    <para>
     The above examples would produce the following output:
    </para>
    <screen>
<![CDATA[
Host info: Localhost via UNIX socket
]]>
    </screen>
   </refsect1>
  </refentry>

<!-- Keep this comment at the end of the file
Local variables:
mode: sgml
sgml-omittag:t
sgml-shorttag:t
sgml-minimize-attributes:nil
sgml-always-quote-attributes:t
sgml-indent-step:1
sgml-indent-data:t
indent-tabs-mode:nil
sgml-parent-document:nil
sgml-default-dtd-file:"../../../../manual.ced"
sgml-exposed-tags:nil
sgml-local-catalogs:nil
sgml-local-ecat-files:nil
End:
vim600: syn=xml fen fdm=syntax fdl=2 si
vim: et tw=78 syn=sgml
vi: ts=1 sw=1
-->