php-doc-en/reference/msql/functions/msql-connect.xml
2005-02-13 20:23:55 +00:00

69 lines
2.1 KiB
XML

<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.10 $ -->
<!-- splitted from ./en/functions/msql.xml, last change in rev 1.2 -->
<refentry id="function.msql-connect">
<refnamediv>
<refname>msql_connect</refname>
<refpurpose>Open mSQL connection</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<methodsynopsis>
<type>int</type><methodname>msql_connect</methodname>
<methodparam choice="opt"><type>string</type><parameter>hostname</parameter></methodparam>
</methodsynopsis>
<para>
<function>msql_connect</function> establishes a connection to a
mSQL server. The <parameter>hostname</parameter> parameter can also
include a port number. e.g. &quot;hostname:port&quot;. It defaults
to 'localhost'.
</para>
<note>
<simpara>
While this function will accept a colon (&quot;:&quot;) as a
host/port seperator, a comma (&quot;,&quot;) is the preferred method.
</simpara>
</note>
<para>
Returns a positive mSQL link identifier on success, or &false; on
error.
</para>
<para>
In case a second call is made to
<function>msql_connect</function> with the same arguments, no new
link will be established, but instead, the link identifier of the
already opened link will be returned.
</para>
<para>
The link to the server will be closed as soon as the execution of
the script ends, unless it's closed earlier by explicitly calling
<function>msql_close</function>.
</para>
<para>
See also
<function>msql_pconnect</function> and
<function>msql_close</function>.
</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:"../../../../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
-->