php-doc-en/reference/maxdb/functions/maxdb-free-result.xml
2010-05-09 03:09:46 +00:00

77 lines
2.2 KiB
XML

<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<refentry xmlns="http://docbook.org/ns/docbook" xml:id="function.maxdb-free-result">
<refnamediv>
<refname>maxdb_free_result</refname>
<refname>maxdb_result::free</refname>
<refpurpose>Frees the memory associated with a result</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<para>&style.procedural;</para>
<methodsynopsis>
<type>void</type><methodname>maxdb_free_result</methodname>
<methodparam><type>resource</type><parameter>result</parameter></methodparam>
</methodsynopsis>
<para>&style.oop;</para>
<methodsynopsis>
<type>void</type><methodname>maxdb_result::free</methodname>
<void />
</methodsynopsis>
<para>
The <function>maxdb_free_result</function> function frees the memory
associated with the result represented by the
<parameter>result</parameter> parameter, which was allocated by
<function>maxdb_query</function>, <function>maxdb_store_result</function>
or <function>maxdb_use_result</function>.
</para>
<note>
<para>
You should always free your result with <function>maxdb_free_result</function>,
when your result resource is not needed anymore.
</para>
</note>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
This function doesn't return any value.
</para>
</refsect1>
<refsect1 role="seealso">
&reftitle.seealso;
<para>
<simplelist>
<member><function>maxdb_query</function></member>
<member><function>maxdb_stmt_store_result</function></member>
<member><function>maxdb_store_result</function></member>
<member><function>maxdb_use_result</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:"~/.phpdoc/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
-->