steinm Fri Mar 31 07:07:46 2006 UTC
Modified files:
/phpdoc/en/reference/paradox/functions px-get-info.xml
Log:
- added section about parameters
- some more info for elements of returned array
- added new array element 'recordsize'
http://cvs.php.net/viewcvs.cgi/phpdoc/en/reference/paradox/functions/px-get-info.xml?r1=1.2&r2=1.3&diff_format=u
Index: phpdoc/en/reference/paradox/functions/px-get-info.xml
diff -u phpdoc/en/reference/paradox/functions/px-get-info.xml:1.2
phpdoc/en/reference/paradox/functions/px-get-info.xml:1.3
--- phpdoc/en/reference/paradox/functions/px-get-info.xml:1.2 Fri Jun 24
13:02:25 2005
+++ phpdoc/en/reference/paradox/functions/px-get-info.xml Fri Mar 31
07:07:46 2006
@@ -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-get-info">
<refnamediv>
@@ -15,24 +15,42 @@
</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>
+ </variablelist>
+ </para>
+ </refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
Returns an associated array with lots of information about a paradox
- file. This array is likely to extend in the future.
+ file. This array is likely to be extended in the future.
</para>
<variablelist>
<varlistentry>
<term>fileversion</term>
<listitem>
- <para>Version of file multiplied by 10.</para>
+ <para>Version of file multiplied by 10, e.g. 70.</para>
</listitem>
</varlistentry>
<varlistentry>
<term>tablename</term>
<listitem>
- <para>Name of table as stored in the file.</para>
+ <para>Name of table as stored in the file. If the database was created
+ by pxlib, then this will be the name of the file without the
+ extension.</para>
</listitem>
</varlistentry>
<varlistentry>
@@ -54,10 +72,19 @@
</listitem>
</varlistentry>
<varlistentry>
+ <term>recordsize</term>
+ <listitem>
+ <para>Number of bytes used for each record. This is the sum of all
+ field sizes (available since version 1.4.2).</para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
<term>maxtablesize</term>
<listitem>
<para>
This value multiplied by 0x400 is the size of a data block in bytes.
+ The maximum number of records in a datablock is the integer part of
+ (maxtablesize * 0x400 - 8) / recordsize.
</para>
</listitem>
</varlistentry>
@@ -77,7 +104,7 @@
<listitem>
<para>
Number of fields used for the primary index. The fields do always start
- as field number 1.
+ with field number 1.
</para>
</listitem>
</varlistentry>
@@ -89,7 +116,8 @@
If the target encoding is not set with
<function>px_set_targetencoding</function> this will be the encoding for
character fields when records are being accessed with
- <function>px_get_record</function>.
+ <function>px_get_record</function> or
+ <function>px_retrieve_record</function>.
</para>
</listitem>
</varlistentry>
