mysql-free-result.xml

<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<!-- EN-Revision: 65e697ff671608989432a6e6bf8ae8128b2be2c7 Maintainer: yannick Status: ready -->
<!-- Reviewed: no -->

<refentry xml:id="function.mysql-free-result" xmlns="http://docbook.org/ns/docbook">
 <refnamediv>
  <refname>mysql_free_result</refname>
  <refpurpose>Libère le résultat de la mémoire</refpurpose>
 </refnamediv>

 <refsynopsisdiv>
  <warning>
   &mysql.alternative.note;
   <simplelist role="alternatives">
    <member><function>mysqli_free_result</function></member>
    <member>Assignez la valeur &null; à l'objet PDO, ou <methodname>PDOStatement::closeCursor</methodname></member>
   </simplelist>
  </warning>
 </refsynopsisdiv>

 <refsect1 role="description">
  &reftitle.description;
  <methodsynopsis>
   <type>bool</type><methodname>mysql_free_result</methodname>
   <methodparam><type>resource</type><parameter>result</parameter></methodparam>
  </methodsynopsis>
  <para>
   <function>mysql_free_result</function> libère toute la mémoire et
   les ressources utilisées par la ressource de résultat <parameter>result</parameter>.
  </para>
  <para>
   <function>mysql_free_result</function> n'est à appeler que si
   vous avez peur d'utiliser trop de mémoire durant l'exécution
   de votre script. Toute la mémoire associée à
   l'identifiant de résultat sera automatiquement libérée.
  </para>
 </refsect1>

 <refsect1 role="parameters">
  &reftitle.parameters;
  <para>
   <variablelist>
    &mysql.result.description;
   </variablelist>
  </para>
 </refsect1>

 <refsect1 role="returnvalues">
  &reftitle.returnvalues;
  <para>
   &return.success;
  </para>
  <para>
   Si la valeur passée à l'argument <parameter>result</parameter> n'est
   pas une ressource, une erreur de niveau <literal>E_WARNING</literal>
   sera émise. Il est important de noter que la fonction 
   <function>mysql_query</function> retourne uniquement une
   &resource; pour les requêtes <literal>SELECT</literal>,
   <literal>SHOW</literal>, <literal>EXPLAIN</literal> et <literal>DESCRIBE</literal>.
  </para>
 </refsect1>

 <refsect1 role="examples">
  &reftitle.examples;
  <para>
   <example>
    <title>Exemple avec <function>mysql_free_result</function></title>
    <programlisting role="php">
<![CDATA[
<?php
$result = mysql_query("SELECT id,email FROM people WHERE id = '42'");
if (!$result) {
   echo 'Impossible d\'exécuter la requête : ' . mysql_error();
   exit;
}
/* Utilisation du résultat */
$row = mysql_fetch_assoc($result);

/* Maintenant, nous libérons le résultat et continuons notre script */
mysql_free_result($result);

echo $row['id'];
echo $row['email'];
?>
]]>
    </programlisting>
   </example>
  </para>
 </refsect1>

 <refsect1 role="notes">
  &reftitle.notes;
  <note>
   <para>
    &info.deprecated.alias;
    <function>mysql_freeresult</function>
   </para>
  </note>
 </refsect1>

 <refsect1 role="seealso">
  &reftitle.seealso;
  <para>
   <simplelist>
    <member><function>mysql_query</function></member>
    <member><function>is_resource</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
-->