php-doc-en/reference/paradox/functions/px-put-record.xml
Daniel Egeberg 96c9d88bad Converted to utf-8
git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@297028 c90b9560-bf6c-de11-be94-00142212c4b1
2010-03-28 22:10:10 +00:00

92 lines
2.6 KiB
XML

<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<!-- splitted from ./en/functions/paradox.xml, last change in rev -->
<refentry xml:id="function.px-put-record" xmlns="http://docbook.org/ns/docbook">
<refnamediv>
<refname>px_put_record</refname>
<refpurpose>Stores record into paradox database</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type>bool</type><methodname>px_put_record</methodname>
<methodparam><type>resource</type><parameter>pxdoc</parameter></methodparam>
<methodparam><type>array</type><parameter>record</parameter></methodparam>
<methodparam choice="opt"><type>int</type><parameter>recpos</parameter><initializer>-1</initializer></methodparam>
</methodsynopsis>
<para>
Stores a record into a paradox database. The record is always added at
the end of the database, regardless of any free slots. Use
<function>px_insert_record</function> to add a new record into the first
free slot found in the database.
</para>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<para>
<variablelist>
<varlistentry>
<term><parameter>pxdoc</parameter></term>
<listitem>
<para>
Resource identifier of the paradox database
as returned by <function>px_new</function>.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>record</parameter></term>
<listitem>
<para>
Associated or indexed array containing the field values as e.g.
returned by <function>px_retrieve_record</function>.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>recpos</parameter></term>
<listitem>
<para>
This optional parameter may be used to specify a record number
greater than the current number of records in the database. The
function will add as many empty records as needed. There is hardly
any need for this parameter.
</para>
</listitem>
</varlistentry>
</variablelist>
</para>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
&return.success;
</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
-->