php-doc-en/reference/dba/functions/dba-delete.xml

61 lines
1.8 KiB
XML
Raw Normal View History

<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.3 $ -->
<!-- splitted from ./en/functions/dba.xml, last change in rev 1.2 -->
<refentry id="function.dba-delete">
<refnamediv>
<refname>dba_delete</refname>
<refpurpose>Delete entry specified by key</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<methodsynopsis>
<type>bool</type><methodname>dba_delete</methodname>
<methodparam><type>string</type><parameter>key</parameter></methodparam>
<methodparam><type>resource</type><parameter>handle</parameter></methodparam>
</methodsynopsis>
<para>
<function>dba_delete</function> deletes the entry specified by
<parameter>key</parameter> from the database specified with
<parameter>handle</parameter>.
</para>
<para>
<parameter>key</parameter> is the key of the entry which is
deleted.
</para>
<para>
<parameter>handle</parameter> is a database handle returned by
<function>dba_open</function>.
</para>
<para>
<function>dba_delete</function> returns &true; or &false;, if the entry is
deleted or not deleted, respectively.
</para>
<para>
See also: <function>dba_exists</function>,
<function>dba_fetch</function>, <function>dba_insert</function>,
and <function>dba_replace</function>.
</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:"../../../../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
-->