<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<refentry xml:id="function.msql-pconnect" xmlns="http://docbook.org/ns/docbook">
 <refnamediv>
  <refname>msql_pconnect</refname>
  <refpurpose>Open persistent mSQL connection</refpurpose>
 </refnamediv>
 <refsect1 role="description">
  &reftitle.description;
  <methodsynopsis>
   <type>resource</type><methodname>msql_pconnect</methodname>
   <methodparam choice="opt"><type>string</type><parameter>hostname</parameter></methodparam>
  </methodsynopsis>
  <para> 
   <function>msql_pconnect</function> acts very much like
   <function>msql_connect</function> with two major differences.
  </para>
  <para> 
   First, when connecting, the function would first try to find a 
   (persistent) link that's already open with the same host.
   If one is found, an identifier for it will be returned instead of opening
   a new connection.
  </para>
  <para> 
   Second, the connection to the SQL server will not be closed when the 
   execution of the script ends.  Instead, the link will remain open for
   future use (<function>msql_close</function> will not close links 
   established by this function).
  </para>
 </refsect1>
 <refsect1 role="parameters">
  &reftitle.parameters;
  <para>
   <variablelist>
    <varlistentry>
     <term><parameter>hostname</parameter></term>
     <listitem>
      <para>
       The hostname can also include a port number. e.g. 
       <literal>hostname,port</literal>.
      </para>
      <para>
       If not specified, the connection is established by the means of a Unix
       domain socket, being more efficient than a localhost TCP socket 
       connection.
      </para>
      <note>
       <simpara>
        While this function will accept a colon (<literal>:</literal>) as a
        host/port separator, a comma (<literal>,</literal>) is the preferred
        method.
       </simpara>
      </note>
     </listitem>
    </varlistentry>
   </variablelist>
  </para>
 </refsect1>
 <refsect1 role="returnvalues">
  &reftitle.returnvalues;
  <para>
   Returns a positive mSQL link identifier on success, or &false; on
   error.
  </para>
 </refsect1>
 <refsect1 role="seealso">
  &reftitle.seealso;
  <para>
   <simplelist>
    <member><function>msql_connect</function></member>
    <member><function>msql_close</function></member>
   </simplelist>
  </para>
 </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:"~/.phpdoc/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
-->