php-doc-en/reference/uodbc/functions/odbc-free-result.xml
Mehdi Achour 20ca2afd4b Switch to new doc style
# 250 to go


git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@249418 c90b9560-bf6c-de11-be94-00142212c4b1
2007-12-30 13:40:52 +00:00

75 lines
2 KiB
XML

<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.6 $ -->
<refentry xml:id="function.odbc-free-result" xmlns="http://docbook.org/ns/docbook">
<refnamediv>
<refname>odbc_free_result</refname>
<refpurpose>Free resources associated with a result</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type>bool</type><methodname>odbc_free_result</methodname>
<methodparam><type>resource</type><parameter>result_id</parameter></methodparam>
</methodsynopsis>
<para>
Free resources associated with a result.
</para>
<para>
<function>odbc_free_result</function> only needs to be called if you are
worried about using too much memory while your script is running.
All result memory will automatically be freed when the script is finished.
</para>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<para>
<variablelist>
<varlistentry>
<term><parameter>result_id</parameter></term>
<listitem>
<para>
The result identifier.
</para>
</listitem>
</varlistentry>
</variablelist>
</para>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
Always returns &true;.
</para>
</refsect1>
<refsect1 role="notes">
&reftitle.notes;
<note>
<para>
If auto-commit is disabled (see <function>odbc_autocommit</function>) and
you call <function>odbc_free_result</function> before committing, all
pending transactions are rolled back.
</para>
</note>
</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
-->