steinm Tue Apr 4 15:32:37 2006 UTC
Modified files:
/phpdoc/en/reference/paradox/functions px-get-parameter.xml
px-create-fp.xml
Log:
- reoganized page
http://cvs.php.net/viewcvs.cgi/phpdoc/en/reference/paradox/functions/px-get-parameter.xml?r1=1.5&r2=1.6&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.5
phpdoc/en/reference/paradox/functions/px-get-parameter.xml:1.6
--- phpdoc/en/reference/paradox/functions/px-get-parameter.xml:1.5 Fri Mar
31 07:06:16 2006
+++ phpdoc/en/reference/paradox/functions/px-get-parameter.xml Tue Apr 4
15:32:37 2006
@@ -1,5 +1,5 @@
<?xml version="1.0" encoding="iso-8859-1"?>
-<!-- $Revision: 1.5 $ -->
+<!-- $Revision: 1.6 $ -->
<!-- splitted from ./en/functions/paradox.xml, last change in rev -->
<refentry id="function.px-get-parameter">
<refnamediv>
@@ -32,48 +32,57 @@
</para>
</listitem>
</varlistentry>
+ <varlistentry>
+ <term><parameter>name</parameter></term>
+ <listitem>
+ <para>
+ The <parameter>name</parameter> can be one of the following:
+ </para>
+ <variablelist>
+ <varlistentry>
+ <term>tablename</term>
+ <listitem>
+ <para>
+ The name of the table as it will be stored in the database header.
+ </para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term>targetencoding</term>
+ <listitem>
+ <para>
+ The encoding for the output. Data which is being read from character
+ 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>
+ <varlistentry>
+ <term>inputencoding</term>
+ <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>
+ </variablelist>
+ </listitem>
+ </varlistentry>
</variablelist>
</para>
</refsect1>
- <refsect1 role="parameters">
- &reftitle.parameters;
+ <refsect1 role="returnvalues">
+ &reftitle.returnvalues;
<para>
- The <parameter>name</parameter> can be one of the following:
+ Returns the value of the parameter or &false; on failure.
</para>
- <variablelist>
- <varlistentry>
- <term>tablename</term>
- <listitem>
- <para>
- The name of the table as it will be stored in the database header.
- </para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term>targetencoding</term>
- <listitem>
- <para>
- The encoding for the output. Data which is being read from character
- 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>
- <varlistentry>
- <term>inputencoding</term>
- <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>
- </variablelist>
</refsect1>
+
</refentry>
<!-- Keep this comment at the end of the file
http://cvs.php.net/viewcvs.cgi/phpdoc/en/reference/paradox/functions/px-create-fp.xml?r1=1.5&r2=1.6&diff_format=u
Index: phpdoc/en/reference/paradox/functions/px-create-fp.xml
diff -u phpdoc/en/reference/paradox/functions/px-create-fp.xml:1.5
phpdoc/en/reference/paradox/functions/px-create-fp.xml:1.6
--- phpdoc/en/reference/paradox/functions/px-create-fp.xml:1.5 Thu Mar 30
15:57:09 2006
+++ phpdoc/en/reference/paradox/functions/px-create-fp.xml Tue Apr 4
15:32:37 2006
@@ -1,5 +1,5 @@
<?xml version="1.0" encoding="iso-8859-1"?>
-<!-- $Revision: 1.5 $ -->
+<!-- $Revision: 1.6 $ -->
<!-- splitted from ./en/functions/paradox.xml, last change in rev -->
<refentry id="function.px-create-fp">
<refnamediv>
@@ -17,22 +17,7 @@
</methodsynopsis>
<para>
Create a new paradox database file. The actual file has to be opened before
- with <function>fopen</function>. Make sure the file is writable. The first
- parameter is the return value of <function>px_new</function>.
- <option>fielddesc</option> is an array containing one element for each
- field specification. A field specification is an array
- itself with either two or three elements.The first element is always a
- string value used as the name of the field. It may not be larger than ten
- characters. The second element contains the field type which is one of the
- constants listed in the table
- <link linkend="paradox.table-fieldtypes">Constants for field types</link>.
- In the case of a character field or bcd field, you will have to provide a
- third element
- specifying the length respectively the precesion of the field. If your
- field specification contains blob fields, you will have to make sure
- to either make the field large enough for all field values to fit or
- specify a blob file with <function>px_set_blob_file</function> for storing
- the blobs. If this is not done the field data is truncated.
+ with <function>fopen</function>. Make sure the file is writable.
</para>
<note>
<para>Calling this functions issues a warning about an empty tablename which
@@ -48,6 +33,51 @@
</note>
</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>file</parameter></term>
+ <listitem>
+ <para>File handle as returned by <function>fopen</function>.
+ </para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term><parameter>fielddesc</parameter></term>
+ <listitem>
+ <para>
+ <option>fielddesc</option> is an array containing one element for each
+ field specification. A field specification is an array itself with
+ either two or three elements.The first element is always a string value
+ used as the name of the field. It may not be larger than ten
+ characters. The second element contains the field type which is one of
+ the constants listed in the table <link
+ linkend="paradox.table-fieldtypes">Constants for field types</link>.
+ In the case of a character field or bcd field, you will have to provide
+ a third element specifying the length respectively the precesion of the
+ field. If your field specification contains blob fields, you will have
+ to make sure to either make the field large enough for all field values
+ to fit or specify a blob file with
+ <function>px_set_blob_file</function> for storing the blobs. If this is
+ not done the field data is truncated.
+ </para>
+ </listitem>
+ </varlistentry>
+ </variablelist>
+ </para>
+ </refsect1>
+
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
