steinm Tue Apr 4 15:29:29 2006 UTC
Modified files:
/phpdoc/en/reference/paradox/functions px-set-targetencoding.xml
px-set-tablename.xml
px-set-blob-file.xml
px-put-record.xml
Log:
- added parameters section
http://cvs.php.net/viewcvs.cgi/phpdoc/en/reference/paradox/functions/px-set-targetencoding.xml?r1=1.6&r2=1.7&diff_format=u
Index: phpdoc/en/reference/paradox/functions/px-set-targetencoding.xml
diff -u phpdoc/en/reference/paradox/functions/px-set-targetencoding.xml:1.6
phpdoc/en/reference/paradox/functions/px-set-targetencoding.xml:1.7
--- phpdoc/en/reference/paradox/functions/px-set-targetencoding.xml:1.6 Fri Feb
10 12:37:21 2006
+++ phpdoc/en/reference/paradox/functions/px-set-targetencoding.xml Tue Apr
4 15:29:29 2006
@@ -1,5 +1,5 @@
<?xml version="1.0" encoding="iso-8859-1"?>
-<!-- $Revision: 1.6 $ -->
+<!-- $Revision: 1.7 $ -->
<!-- splitted from ./en/functions/paradox.xml, last change in rev -->
<refentry id="function.px-set-targetencoding">
<refnamediv>
@@ -20,7 +20,8 @@
encoding is not set, the character data will be returned in the DOS code
page encoding as specified in the database file. The
<parameter>encoding</parameter> can be any string identifier known to
- iconv or recode.
+ iconv or recode. On unix systems run <literal>iconv -l</literal> for
+ a list of available encodings.
</para>
<para>This function is deprecated and should be replaced by calling
<function>px_set_parameter</function>.
@@ -31,6 +32,32 @@
</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>encoding</parameter></term>
+ <listitem>
+ <para>
+ The encoding for the output. Data which is being read from
+ character fields is recoded into the targetencoding.
+ </para>
+ </listitem>
+ </varlistentry>
+ </variablelist>
+ </para>
+ </refsect1>
+
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
http://cvs.php.net/viewcvs.cgi/phpdoc/en/reference/paradox/functions/px-set-tablename.xml?r1=1.3&r2=1.4&diff_format=u
Index: phpdoc/en/reference/paradox/functions/px-set-tablename.xml
diff -u phpdoc/en/reference/paradox/functions/px-set-tablename.xml:1.3
phpdoc/en/reference/paradox/functions/px-set-tablename.xml:1.4
--- phpdoc/en/reference/paradox/functions/px-set-tablename.xml:1.3 Wed Feb
8 06:27:39 2006
+++ phpdoc/en/reference/paradox/functions/px-set-tablename.xml Tue Apr 4
15:29:29 2006
@@ -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-set-tablename">
<refnamediv>
@@ -21,6 +21,32 @@
</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>tablename</parameter></term>
+ <listitem>
+ <para>
+ The name of the table. If it is not set explicitly it will be set
+ to the name of the database file.
+ </para>
+ </listitem>
+ </varlistentry>
+ </variablelist>
+ </para>
+ </refsect1>
+
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
http://cvs.php.net/viewcvs.cgi/phpdoc/en/reference/paradox/functions/px-set-blob-file.xml?r1=1.1&r2=1.2&diff_format=u
Index: phpdoc/en/reference/paradox/functions/px-set-blob-file.xml
diff -u phpdoc/en/reference/paradox/functions/px-set-blob-file.xml:1.1
phpdoc/en/reference/paradox/functions/px-set-blob-file.xml:1.2
--- phpdoc/en/reference/paradox/functions/px-set-blob-file.xml:1.1 Sun Jun
19 18:42:58 2005
+++ phpdoc/en/reference/paradox/functions/px-set-blob-file.xml Tue Apr 4
15:29:29 2006
@@ -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-set-blob-file">
<refnamediv>
@@ -15,11 +15,19 @@
<methodparam><type>string</type><parameter>filename</parameter></methodparam>
</methodsynopsis>
<para>
- Sets the name of the file where blobs are going to be read from. Without
- calling this function, <function>px_get_record</function> will only return
+ Sets the name of the file where blobs are going to be read from or written
+ into. Without
+ calling this function, <function>px_get_record</function> or
+ <function>px_retrieve_record</function> will only return
data in blob fields if the data is part of the record and not stored in the
blob file. Blob data is stored in the record if it is small enough to fit
- in the size of the blob field.
+ in the size of the blob field.</para>
+ <para>
+ Calling <function>px_put_record</function>,
+ <function>px_insert_record</function>, or
+ <function>px_update_record</function> without calling
+ <function>px_set_blob_file</function> will result in truncated blob fields
+ unless the data fits into the database file.
</para>
<para>
Calling this function twice will close the first blob file and open the new
@@ -27,6 +35,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>
+ <varlistentry>
+ <term><parameter>filename</parameter></term>
+ <listitem>
+ <para>
+ The name of the file. Its extension should be <literal>.MB</literal>.
+ </para>
+ </listitem>
+ </varlistentry>
+ </variablelist>
+ </para>
+ </refsect1>
+
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
http://cvs.php.net/viewcvs.cgi/phpdoc/en/reference/paradox/functions/px-put-record.xml?r1=1.4&r2=1.5&diff_format=u
Index: phpdoc/en/reference/paradox/functions/px-put-record.xml
diff -u phpdoc/en/reference/paradox/functions/px-put-record.xml:1.4
phpdoc/en/reference/paradox/functions/px-put-record.xml:1.5
--- phpdoc/en/reference/paradox/functions/px-put-record.xml:1.4 Wed Feb 8
08:27:46 2006
+++ phpdoc/en/reference/paradox/functions/px-put-record.xml Tue Apr 4
15:29:29 2006
@@ -1,5 +1,5 @@
<?xml version="1.0" encoding="iso-8859-1"?>
-<!-- $Revision: 1.4 $ -->
+<!-- $Revision: 1.5 $ -->
<!-- splitted from ./en/functions/paradox.xml, last change in rev -->
<refentry id="function.px-put-record">
<refnamediv>
@@ -23,6 +23,43 @@
</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>
