Files
Mikhail Alferov f5a73a695e Update delete.xml
2024-06-19 04:51:41 +03:00

105 lines
3.0 KiB
XML
Raw Permalink Blame History

This file contains ambiguous Unicode characters

This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

<?xml version="1.0" encoding="utf-8"?>
<!-- EN-Revision: 29054534f689e0ed3a1ebe982d9ff996bf97d3ca Maintainer: sergey Status: ready -->
<!-- Reviewed: no -->
<refentry xml:id="quickhashintstringhash.delete" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
<refnamediv>
<refname>QuickHashIntStringHash::delete</refname>
<refpurpose>Удаляет запись из хеша</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<modifier>public</modifier> <type>bool</type><methodname>QuickHashIntStringHash::delete</methodname>
<methodparam><type>int</type><parameter>key</parameter></methodparam>
</methodsynopsis>
<para>
Метод удаляет запись из хеша и возвращает информацию о том, удалилась ли запись или нет.
Соответствующие структуры памяти будут освобождены не сразу, а при освобождении самого хеша.
</para>
<para>
Элементы нельзя удалить, если хеш используется в итераторе.
Метод не выбросит исключение, а просто вернёт &false;,
как это произошло бы при любой другой ошибке удаления.
</para>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<para>
<variablelist>
<varlistentry>
<term><parameter>key</parameter></term>
<listitem>
<para>
Ключ удаляемой записи.
</para>
</listitem>
</varlistentry>
</variablelist>
</para>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
Метод возвращает &true;, если запись удалилась, иначе &false;.
</para>
</refsect1>
<refsect1 role="examples">
&reftitle.examples;
<para>
<example>
<title>Пример использования метода <function>QuickHashIntStringHash::delete</function></title>
<programlisting role="php">
<![CDATA[
<?php
$hash = new QuickHashIntStringHash(1024);
var_dump($hash->exists(4));
var_dump($hash->add(4, "five"));
var_dump($hash->delete(4));
var_dump($hash->exists(4));
var_dump($hash->delete(4));
?>
]]>
</programlisting>
&example.outputs.similar;
<screen>
<![CDATA[
bool(false)
bool(true)
bool(true)
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
-->