php-doc-en/reference/sam/functions/SAM-Connection-commit.xml

71 lines
1.6 KiB
XML
Raw Normal View History

<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.4 $ -->
<refentry id='function.SAM-Connection-commit'>
<refnamediv>
<refname>SAMConnection::commit()</refname>
<refpurpose>
Commits (completes) the current unit of work.
</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<para>
Calling the "commit" method on a Connection object commits (completes) all in-flight
transactions that are part of the current unit of work.
</para>
<classsynopsis>
<ooclass><classname>SAMConnection</classname></ooclass>
<methodsynopsis>
<type>bool</type><methodname>commit</methodname><void/>
</methodsynopsis>
</classsynopsis>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
This method returns &false; if an error occurs.
</para>
</refsect1>
<refsect1 role="examples">
&reftitle.examples;
<para>
<example>
<title>Committing the current unit of work</title>
<programlisting role="php">
<![CDATA[
<?php
if (!$conn->commit()) {
// The commit failed!
echo "Commit failed ($conn->errno) $conn->error";
}
?>
]]>
</programlisting>
</example>
</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
-->