- added list of parameters

git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@210406 c90b9560-bf6c-de11-be94-00142212c4b1
This commit is contained in:
Uwe Steinmann 2006-03-30 15:50:47 +00:00
parent 89359925e1
commit 057765cdff
4 changed files with 89 additions and 13 deletions

View file

@ -1,5 +1,5 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.1 $ -->
<!-- $Revision: 1.2 $ -->
<!-- splitted from ./en/functions/paradox.xml, last change in rev -->
<refentry id="function.px-close">
<refnamediv>
@ -19,6 +19,31 @@
</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>
</variablelist>
</para>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
&return.success;
</para>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
@ -31,7 +56,6 @@
<para>
<simplelist>
<member><function>px_open_fp</function></member>
<member><function>another_func</function></member>
<member>The example at <function>px_new</function></member>
</simplelist>
</para>

View file

@ -1,5 +1,5 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.2 $ -->
<!-- $Revision: 1.3 $ -->
<!-- splitted from ./en/functions/paradox.xml, last change in rev -->
<refentry id="function.px-delete">
<refnamediv>
@ -18,6 +18,23 @@
</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>
</variablelist>
</para>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>

View file

@ -1,5 +1,5 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.3 $ -->
<!-- $Revision: 1.4 $ -->
<!-- splitted from ./en/functions/paradox.xml, last change in rev -->
<refentry id="function.px-get-field">
<refnamediv>
@ -16,6 +16,33 @@
</methodsynopsis>
</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>fieldno</parameter></term>
<listitem>
<para>
Number of the field. The first field has number 0. Specifying a field
number less than 0 and greater or equal the number of fields will
trigger an error.
</para>
</listitem>
</varlistentry>
</variablelist>
</para>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>

View file

@ -1,5 +1,5 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.2 $ -->
<!-- $Revision: 1.3 $ -->
<!-- splitted from ./en/functions/paradox.xml, last change in rev -->
<refentry id="function.px-update-record">
<refnamediv>
@ -15,6 +15,22 @@
<methodparam><type>array</type><parameter>data</parameter></methodparam>
<methodparam><type>int</type><parameter>num</parameter></methodparam>
</methodsynopsis>
<para>
Updates an exiting record in the database. The record starts at 0.
</para>
<para>
The record data is passed as an array of field values. The elements in
the array must correspond to the fields in the database. If the array
has less elements than fields in the database, the remaining fields
will be set to null.
</para>
<note>
<para>
This function is only available if pxlib &gt;= 0.6.0 is used.
</para>
</note>
</refsect1>
<refsect1 role="parameters">
@ -50,14 +66,6 @@
</varlistentry>
</variablelist>
</para>
<para>
This function updates a record in the database.
</para>
<note>
<para>
This function is only available if pxlib &gt;= 0.6.0 is used.
</para>
</note>
</refsect1>