Files
2024-08-27 12:53:26 +01:00

109 lines
2.9 KiB
XML

<?xml version="1.0" encoding="utf-8"?>
<!-- EN-Revision: 29054534f689e0ed3a1ebe982d9ff996bf97d3ca Maintainer: Fan2Shrek Status: ready -->
<!-- Reviewed: yes -->
<refentry xml:id="quickhashstringinthash.delete" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
<refnamediv>
<refname>QuickHashStringIntHash::delete</refname>
<refpurpose>Cette méthode supprime une entrée du hachage</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<modifier>public</modifier> <type>bool</type><methodname>QuickHashStringIntHash::delete</methodname>
<methodparam><type>string</type><parameter>key</parameter></methodparam>
</methodsynopsis>
<para>
Cette méthode supprime une entrée du hachage, et retourne si l'entrée a été
supprimée ou non. Les structures mémoire associées ne seront pas libérées immédiatement,
mais plutôt lorsque le hachage lui-même est libéré.
</para>
<para>
Les éléments ne peuvent pas être supprimés lorsque le hachage est utilisé dans un itérateur. La
méthode ne lancera pas d'exception, mais renverra simplement &false; comme cela se produirait
avec tout autre échec de suppression.
</para>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<para>
<variablelist>
<varlistentry>
<term><parameter>key</parameter></term>
<listitem>
<para>
La clé de l'entrée à supprimer.
</para>
</listitem>
</varlistentry>
</variablelist>
</para>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
&true; lorsque l'entrée a été supprimée, et &false; si l'entrée n'a pas été supprimée.
</para>
</refsect1>
<refsect1 role="examples">
&reftitle.examples;
<para>
<example>
<title>Exemple de <function>QuickHashStringIntHash::delete</function></title>
<programlisting role="php">
<![CDATA[
<?php
$hash = new QuickHashStringIntHash( 1024 );
var_dump( $hash->exists( 'four' ) );
var_dump( $hash->add( 'four', 5 ) );
var_dump( $hash->get( 'four' ) );
var_dump( $hash->delete( 'four' ) );
var_dump( $hash->exists( 'four' ) );
var_dump( $hash->get( 'four' ) );
var_dump( $hash->delete( 'four' ) );
?>
]]>
</programlisting>
&example.outputs.similar;
<screen>
<![CDATA[
bool(false)
bool(true)
int(5)
bool(true)
bool(false)
bool(false)
bool(false)
]]>
</screen>
</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:"~/.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
-->