php-doc-en/reference/sesam/functions/sesam-disconnect.xml
2003-12-11 15:42:10 +00:00

77 lines
2.2 KiB
XML

<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.4 $ -->
<!-- splitted from ./en/functions/sesam.xml, last change in rev 1.1 -->
<refentry id="function.sesam-disconnect">
<refnamediv>
<refname>sesam_disconnect</refname>
<refpurpose>Detach from SESAM connection</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<methodsynopsis>
<type>bool</type><methodname>sesam_disconnect</methodname>
<void/>
</methodsynopsis>
<para>
Returns: always &true;.
</para>
<para>
<function>sesam_disconnect</function> closes the logical link to
a SESAM database (without actually disconnecting and unloading
the driver).
</para>
<para>
Note that this isn't usually necessary, as the open connection is
automatically closed at the end of the script's execution.
Uncommitted data will be discarded, because an implicit
<function>sesam_rollback</function> is executed.
</para>
<para>
<function>sesam_disconnect</function> will not close the
persistent link, it will only invalidate the currently defined
<parameter>"catalog"</parameter>, <parameter>"schema"</parameter>
and <parameter>"user"</parameter> triple, so that any sesam
function called after <function>sesam_disconnect</function> will
fail.
</para>
<para>
<example>
<title>Closing a SESAM connection</title>
<programlisting role="php">
<![CDATA[
<?php
if (sesam_connect ("mycatalog", "myschema", "otto")) {
/* ... some queries and stuff ... */
sesam_disconnect();
}
?>
]]>
</programlisting>
</example>
</para>
<para>
See also <function>sesam_connect</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
-->