php-doc-en/reference/fbsql/functions/fbsql-connect.xml
Hartmut Holzgraefe 5b9fc29465 revision tags added
git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@78496 c90b9560-bf6c-de11-be94-00142212c4b1
2002-04-17 06:45:35 +00:00

88 lines
2.6 KiB
XML

<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.2 $ -->
<!-- splitted from ./en/functions/fbsql.xml, last change in rev 1.1 -->
<refentry id="function.fbsql-connect">
<refnamediv>
<refname>fbsql_connect</refname>
<refpurpose>Open a connection to a FrontBase Server</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<methodsynopsis>
<type>resource</type><methodname>fbsql_connect</methodname>
<methodparam choice="opt"><type>string</type><parameter>
hostname
</parameter></methodparam>
<methodparam choice="opt"><type>string</type><parameter>
username
</parameter></methodparam>
<methodparam choice="opt"><type>string</type><parameter>
password
</parameter></methodparam>
</methodsynopsis>
<para>
Returns a positive FrontBase link identifier on success, or an
error message on failure.
</para>
<para>
<function>fbsql_connect</function> establishes a connection to a
FrontBase server. The following defaults are assumed for missing
optional parameters: <parameter>hostname</parameter> = '&null;',
<parameter>username</parameter> = '_SYSTEM' and
<parameter>password</parameter> = empty password.
</para>
<para>
If a second call is made to <function>fbsql_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>fbsql_close</function>.
</para>
<example>
<title><function>fbsql_connect</function> example</title>
<programlisting role="php">
<![CDATA[
<?php
$link = fbsql_connect ("localhost", "_SYSTEM", "secret")
or die ("Could not connect");
print ("Connected successfully");
fbsql_close ($link);
?>
]]>
</programlisting>
</example>
<para>
See also
<function>fbsql_pconnect</function> and
<function>fbsql_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
-->