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
|
<?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-record" xmlns="http://docbook.org/ns/docbook">
<refnamediv>
<refname>px_get_record</refname>
<refpurpose>Returns record of paradox database</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type>array</type><methodname>px_get_record</methodname>
<methodparam><type>resource</type><parameter>pxdoc</parameter></methodparam>
<methodparam><type>int</type><parameter>num</parameter></methodparam>
<methodparam choice="opt"><type>int</type><parameter>mode</parameter><initializer>0</initializer></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>
<varlistentry>
<term><parameter>num</parameter></term>
<listitem>
<para>
The record number is an artificial number counting records in the order
as they are stored in the database. The first record has number 0.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>mode</parameter></term>
<listitem>
<para>
The optional <parameter>mode</parameter> can be
<constant>PX_KEYTOLOWER</constant> or <constant>PX_KEYTOUPPER</constant>
in order to convert the keys of the returned array into lower or
upper case. If
<parameter>mode</parameter> is not passed or is 0, then the key will be
exactly like the field name. The element values will contain the field
values. NULL values will be retained and are different from 0.0, 0 or
the empty string. Fields of type <constant>PX_FIELD_TIME</constant>
will be returned as an integer counting the number of milliseconds
starting at midnight. A timestamp
(<constant>PX_FIELD_TIMESTAMP</constant>) and date
(<constant>PX_FIELD_DATE</constant>) are floating point respectively
int values counting milliseconds respectively days starting
at the beginning of julian calendar.
Use the functions <function>px-timestamp2string</function> and
<function>px-date2string</function> to convert them into a character
representation.
</para>
</listitem>
</varlistentry>
</variablelist>
</para>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
Returns the <parameter>num</parameter>'th record from the paradox
database. The record is returned as an associated array with its keys
being the field names.
</para>
</refsect1>
<refsect1 role="seealso">
&reftitle.seealso;
<para>
<simplelist>
<member><function>px_retrieve_record</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
-->
|
