steinm Fri Mar 31 07:06:16 2006 UTC
Modified files:
/phpdoc/en/reference/paradox/functions px-get-parameter.xml
Log:
- added section with parameters- more info on how recoding works
http://cvs.php.net/viewcvs.cgi/phpdoc/en/reference/paradox/functions/px-get-parameter.xml?r1=1.4&r2=1.5&diff_format=u
Index: phpdoc/en/reference/paradox/functions/px-get-parameter.xml
diff -u phpdoc/en/reference/paradox/functions/px-get-parameter.xml:1.4
phpdoc/en/reference/paradox/functions/px-get-parameter.xml:1.5
--- phpdoc/en/reference/paradox/functions/px-get-parameter.xml:1.4 Wed Feb
8 06:33:08 2006
+++ phpdoc/en/reference/paradox/functions/px-get-parameter.xml Fri Mar 31
07:06:16 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-get-parameter">
<refnamediv>
@@ -18,6 +18,23 @@
Gets various parameters.
</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="parameters">
&reftitle.parameters;
@@ -38,7 +55,10 @@
<listitem>
<para>
The encoding for the output. Data which is being read from character
- fields is recoded into the targetencoding.
+ fields with <function>px_get_record</function> or
+ <function>px_retrieve_record</function> is recoded into the
+ targetencoding. If it is not set, then the data
+ will be delivered as stored in the database file.
</para>
</listitem>
</varlistentry>
@@ -47,6 +67,8 @@
<listitem>
<para>
The encoding of the input data which is to be stored into the database.
+ When storing data of character fields in the database, the data is
+ expected to be delivered in this encoding.
</para>
</listitem>
</varlistentry>
