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
|
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.16 $ -->
<refentry xml:id="function.msql-connect" xmlns="http://docbook.org/ns/docbook">
<refnamediv>
<refname>msql_connect</refname>
<refpurpose>Open mSQL connection</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type>resource</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.
</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>
</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 then more efficient then a localhost TCP socket
connection.
</para>
<note>
<para>
While this function will accept a colon (<literal>:</literal>) as a
host/port separator, a comma (<literal>,</literal>) is the preferred
method.
</para>
</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_pconnect</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:"../../../../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
-->
|
