reference/dbase/functions/dbase-get-record-with-names.xml
1f13e161042e2379a5882cf7c09e9002b3281c12
...
...
@@ -11,8 +11,8 @@
11
11
&reftitle.description;
12
12
<methodsynopsis>
13
13
<type>array</type><methodname>dbase_get_record_with_names</methodname>
14
-
<methodparam><type>int</type><parameter>dbase_identifier</parameter></methodparam>
15
-
<methodparam><type>int</type><parameter>record_number</parameter></methodparam>
14
+
<methodparam><type>resource</type><parameter>database</parameter></methodparam>
15
+
<methodparam><type>int</type><parameter>number</parameter></methodparam>
16
16
</methodsynopsis>
17
17
<para>
18
18
Gets a record from a dBase database as an associative array.
...
...
@@ -23,19 +23,20 @@
23
23
<para>
24
24
<variablelist>
25
25
<varlistentry>
26
-
<term><parameter>dbase_identifier</parameter></term>
26
+
<term><parameter>database</parameter></term>
27
27
<listitem>
28
28
<para>
29
-
The database link identifier, returned by <function>dbase_open</function>
29
+
The database resource, returned by <function>dbase_open</function>
30
30
or <function>dbase_create</function>.
31
31
</para>
32
32
</listitem>
33
33
</varlistentry>
34
34
<varlistentry>
35
-
<term><parameter>record_number</parameter></term>
35
+
<term><parameter>number</parameter></term>
36
36
<listitem>
37
37
<para>
38
-
The index of the record.
38
+
The index of the record between <literal>1</literal> and
39
+
<literal>dbase_numrecords($dbase_identifier)</literal>.
39
40
</para>
40
41
</listitem>
41
42
</varlistentry>
...
...
@@ -48,27 +49,38 @@
48
49
An associative array with the record. This will also include a key named
49
50
<literal>deleted</literal> which is set to 1 if the record has been marked
50
51
for deletion (see <function>dbase_delete_record</function>).
52
+
Therefore it is not possible to retrieve the value of a field named
53
+
<literal>deleted</literal> with this function.
51
54
</para>
52
-
<para>
53
-
Each field is converted to the appropriate PHP type, except:
54
-
<itemizedlist>
55
-
<listitem>
56
-
<simpara>
57
-
Dates are left as strings.
58
-
</simpara>
59
-
</listitem>
60
-
<listitem>
61
-
<simpara>
62
-
Integers that would have caused an overflow (&gt; 32 bits)
63
-
are returned as strings.
64
-
</simpara>
65
-
</listitem>
66
-
</itemizedlist>
67
-
</para>
55
+
&dbase.type-conversion;
68
56
<para>
69
57
On error, <function>dbase_get_record_with_names</function> will return &false;.
70
58
</para>
71
59
</refsect1>
60
+

61
+
<refsect1 role="changelog">
62
+
&reftitle.changelog;
63
+
<informaltable>
64
+
<tgroup cols="2">
65
+
<thead>
66
+
<row>
67
+
<entry>&Version;</entry>
68
+
<entry>&Description;</entry>
69
+
</row>
70
+
</thead>
71
+
<tbody>
72
+
<row>
73
+
<entry>dbase 7.0.0</entry>
74
+
<entry>
75
+
<parameter>database</parameter> is now a <type>resource</type>
76
+
instead of an <type>int</type>.
77
+
</entry>
78
+
</row>
79
+
</tbody>
80
+
</tgroup>
81
+
</informaltable>
82
+
</refsect1>
83
+

72
84
<refsect1 role="examples">
73
85
&reftitle.examples;
74
86
<para>
75
87