php-doc-en/reference/paradox/functions/px-delete-record.xml
Jakub Vrana f79001ffb1 Fix protos
git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@206727 c90b9560-bf6c-de11-be94-00142212c4b1
2006-02-08 08:27:46 +00:00

76 lines
2 KiB
XML

<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.2 $ -->
<!-- splitted from ./en/functions/paradox.xml, last change in rev -->
<refentry id="function.px-delete-record">
<refnamediv>
<refname>px_delete_record</refname>
<refpurpose>Deletes record from paradox database</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type>bool</type><methodname>px_delete_record</methodname>
<methodparam><type>resource</type><parameter>pxdoc</parameter></methodparam>
<methodparam><type>int</type><parameter>num</parameter></methodparam>
</methodsynopsis>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<para>
<variablelist>
<varlistentry>
<term><parameter>pxdoc</parameter></term>
<listitem>
<para>
Resource identifier of the paradox database.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>num</parameter></term>
<listitem>
<para>
The record number is an artificial number counting records in the order
as they are stored in the database. The first record has number 0.
</para>
</listitem>
</varlistentry>
</variablelist>
</para>
<para>
This function deletes a record from the database. It does not free
the space in the database file but just marks it as deleted. Inserting
a new record afterwards will reuse the space.
</para>
<note>
<para>
This function is only available if pxlib &gt;= 0.6.0 is used.
</para>
</note>
</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
-->