php-doc-en/reference/mysqli/mysqli_result/free.xml
Jakub Vrana d316f465df Hide properties from method lists
git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@322005 c90b9560-bf6c-de11-be94-00142212c4b1
2012-01-10 08:41:49 +00:00

91 lines
2.3 KiB
XML

<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<refentry xml:id="mysqli-result.free" xmlns="http://docbook.org/ns/docbook">
<refnamediv>
<refname>mysqli_result::free</refname>
<refname>mysqli_free_result</refname>
<refpurpose>Frees the memory associated with a result</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<para>&style.oop;</para>
<methodsynopsis role="oop">
<type>void</type><methodname>mysqli_result::free</methodname>
<void />
</methodsynopsis>
<methodsynopsis>
<type>void</type><methodname>mysqli_result::close</methodname>
<void />
</methodsynopsis>
<methodsynopsis>
<type>void</type><methodname>mysqli_result::free_result</methodname>
<void />
</methodsynopsis>
<para>&style.procedural;</para>
<methodsynopsis>
<type>void</type><methodname>mysqli_free_result</methodname>
<methodparam><type>mysqli_result</type><parameter>result</parameter></methodparam>
</methodsynopsis>
<para>
Frees the memory associated with the result.
</para>
<note>
<para>
You should always free your result with
<function>mysqli_free_result</function>, when your result object is not
needed anymore.
</para>
</note>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<para>
<variablelist>
&mysqli.result.description;
</variablelist>
</para>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
&return.void;
</para>
</refsect1>
<refsect1 role="seealso">
&reftitle.seealso;
<para>
<simplelist>
<member><function>mysqli_query</function></member>
<member><function>mysqli_stmt_store_result</function></member>
<member><function>mysqli_store_result</function></member>
<member><function>mysqli_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
-->