1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
|
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision: 297028 $ -->
<!-- splitted from ./en/functions/paradox.xml, last change in rev -->
<refentry xml:id="function.px-get-info" xmlns="http://docbook.org/ns/docbook">
<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="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 be extended in the future.
</para>
<variablelist>
<varlistentry>
<term>fileversion</term>
<listitem>
<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. If the database was created
by pxlib, then this will be the name of the file without the
extension.</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 usually 0x800.</para>
</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>
<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
with 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> or
<function>px_retrieve_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:"~/.phpdoc/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
-->
|
