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

<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.4 $ -->
  <refentry id="function.dbase-replace-record">
   <refnamediv>
    <refname>dbase_replace_record</refname>
    <refpurpose>Replace a record in a dBase database</refpurpose>
   </refnamediv>
   <refsect1 role="description">
    &reftitle.description;
     <methodsynopsis>
      <type>bool</type><methodname>dbase_replace_record</methodname>
      <methodparam><type>int</type><parameter>dbase_identifier</parameter></methodparam>
      <methodparam><type>array</type><parameter>record</parameter></methodparam>
      <methodparam><type>int</type><parameter>record_number</parameter></methodparam>
     </methodsynopsis>
    <para>
     Replaces the given record in the database with the given data.
    </para>
   </refsect1>
   <refsect1 role="parameters">
    &reftitle.parameters;
    <para>
     <variablelist>
      <varlistentry>
       <term><parameter>dbase_identifier</parameter></term>
       <listitem>
        <para>
         The dbase link identifier, returned by <function>dbase_open</function>
         or <function>dbase_create</function>.
        </para>
       </listitem>
      </varlistentry>
      <varlistentry>
       <term><parameter>record</parameter></term>
       <listitem>
        <para>
         An indexed array of data. The number of items must be equal to the number of 
         fields in the database, otherwise <function>dbase_add_record</function>
         will fail.
        </para>
        <note>
         <para>
          If you're using <function>dbase_get_record</function> return value for this
          parameter, remember to reset the key named <literal>deleted</literal>.
         </para>
        </note>
       </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_delete_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
-->