mirror of
https://github.com/sigmasternchen/php-doc-en
synced 2025-03-27 14:28:56 +00:00
98898d08e6
git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@188778 c90b9560-bf6c-de11-be94-00142212c4b1
130 lines
3.4 KiB
XML
130 lines
3.4 KiB
XML
<?xml version="1.0" encoding="iso-8859-1"?>
|
|
<!-- $Revision: 1.1 $ -->
|
|
<!-- splitted from ./en/functions/paradox.xml, last change in rev -->
|
|
<refentry id="function.px-get-info">
|
|
<refnamediv>
|
|
<refname>px_get_info</refname>
|
|
<refpurpose>Return lots of information about a paradox file</refpurpose>
|
|
</refnamediv>
|
|
|
|
<refsect1 role="description">
|
|
&reftitle.description;
|
|
<methodsynopsis>
|
|
<type>array</type><methodname>px_get_info</methodname>
|
|
<methodparam><type>resource</type><parameter>pxdoc</parameter></methodparam>
|
|
</methodsynopsis>
|
|
</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.
|
|
</para>
|
|
<variablelist>
|
|
<varlistentry>
|
|
<term>fileversion</term>
|
|
<listitem>
|
|
<para>Version of file multiplied by 10.</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term>tablename</term>
|
|
<listitem>
|
|
<para>Name of table as stored in the file.</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term>numrecords</term>
|
|
<listitem>
|
|
<para>Number of records in this table.</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term>numfields</term>
|
|
<listitem>
|
|
<para>Number of fields in this table.</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term>headersize</term>
|
|
<listitem>
|
|
<para>Number of bytes used for the header. This is usally 0x800.</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term>maxtablesize</term>
|
|
<listitem>
|
|
<para>
|
|
This value multiplied by 0x400 is the size of a data block in bytes.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term>numdatablocks</term>
|
|
<listitem>
|
|
<para>
|
|
The number of data blocks in the file. Each data block contains a
|
|
certain number of records which depends on the record size and the data
|
|
block size (maxtablesize). Data blocks may not necessarily be
|
|
completely filled.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term>numindexfields</term>
|
|
<listitem>
|
|
<para>
|
|
Number of fields used for the primary index. The fields do always start
|
|
as field number 1.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term>codepage</term>
|
|
<listitem>
|
|
<para>
|
|
The DOS codepage which was used for encoding fields with character data.
|
|
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>.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</refsect1>
|
|
|
|
<refsect1 role="seealso">
|
|
&reftitle.seealso;
|
|
<para>
|
|
<simplelist>
|
|
<member><function>px_numfields</function></member>
|
|
<member><function>px_numrecords</function></member>
|
|
</simplelist>
|
|
</para>
|
|
</refsect1>
|
|
</refentry>
|
|
|
|
<!-- Keep this comment at the end of the file
|
|
Local variables:
|
|
mode: sgml
|
|
sgml-omittag:t
|
|
sgml-shorttag:t
|
|
sgml-minimize-attributes:nil
|
|
sgml-always-quote-attributes:t
|
|
sgml-indent-step:1
|
|
sgml-indent-data:t
|
|
indent-tabs-mode:nil
|
|
sgml-parent-document:nil
|
|
sgml-default-dtd-file:"../../../../manual.ced"
|
|
sgml-exposed-tags:nil
|
|
sgml-local-catalogs:nil
|
|
sgml-local-ecat-files:nil
|
|
End:
|
|
vim600: syn=xml fen fdm=syntax fdl=2 si
|
|
vim: et tw=78 syn=sgml
|
|
vi: ts=1 sw=1
|
|
-->
|
|
|