php-doc-en/reference/dbase/functions/dbase-delete-record.xml

<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.7 $ -->
<refentry xml:id="function.dbase-delete-record" xmlns="http://docbook.org/ns/docbook">
 <refnamediv>
  <refname>dbase_delete_record</refname>
  <refpurpose>Deletes a record from a database</refpurpose>
 </refnamediv>
 <refsect1 role="description">
  &reftitle.description;
  <methodsynopsis>
   <type>bool</type><methodname>dbase_delete_record</methodname>
   <methodparam><type>int</type><parameter>dbase_identifier</parameter></methodparam>
   <methodparam><type>int</type><parameter>record_number</parameter></methodparam>
  </methodsynopsis>
  <para>
   Marks the given record to be deleted from the database.
  </para>
  <note>
   <para>
    To actually remove the record from the database, you must also call
    <function>dbase_pack</function>.
   </para>
  </note>
 </refsect1>
 <refsect1 role="parameters">
  &reftitle.parameters;
  <para>
   <variablelist>
    <varlistentry>
     <term><parameter>dbase_identifier</parameter></term>
     <listitem>
      <para>
       The database link identifier, returned by <function>dbase_open</function>
       or <function>dbase_create</function>.
      </para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><parameter>record_number</parameter></term>
     <listitem>
      <para>
       An integer which spans from 1 to the number of records in the database
       (as returned by <function>dbase_numrecords</function>).
      </para>
     </listitem>
    </varlistentry>
   </variablelist>
  </para>
 </refsect1>
 <refsect1 role="returnvalues">
  &reftitle.returnvalues;
  <para>
   &return.success;
  </para>
 </refsect1>
 <refsect1 role="seealso">
  &reftitle.seealso;
  <para>
   <simplelist>
    <member><function>dbase_add_record</function></member>
    <member><function>dbase_replace_record</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:"../../../../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
-->