reference/dbase/functions/dbase-open.xml
b95d28e6ec86e4a71e012737d36ebdc1cf009180
...
...
@@ -8,15 +8,14 @@
8
8
<refsect1 role="description">
9
9
&reftitle.description;
10
10
<methodsynopsis>
11
-
<type>int</type><methodname>dbase_open</methodname>
12
-
<methodparam><type>string</type><parameter>filename</parameter></methodparam>
11
+
<type class="union"><type>resource</type><type>false</type></type><methodname>dbase_open</methodname>
12
+
<methodparam><type>string</type><parameter>path</parameter></methodparam>
13
13
<methodparam><type>int</type><parameter>mode</parameter></methodparam>
14
14
</methodsynopsis>
15
15
<para>
16
16
<function>dbase_open</function> opens a dBase database with the given
17
17
access mode.
18
18
</para>
19
-
&note.sm.uidcheck;
20
19
&note.open-basedir.func;
21
20
</refsect1>
22
21
<refsect1 role="parameters">
...
...
@@ -24,10 +23,10 @@
24
23
<para>
25
24
<variablelist>
26
25
<varlistentry>
27
-
<term><parameter>filename</parameter></term>
26
+
<term><parameter>path</parameter></term>
28
27
<listitem>
29
28
<para>
30
-
The name of the database. It can be a relative or absolute path to
29
+
The path of the database. It can be a relative or absolute path to
31
30
the file where dBase will store your data.
32
31
</para>
33
32
</listitem>
...
...
@@ -47,11 +46,47 @@
47
46
<parameter>mode</parameter>.
48
47
</para>
49
48
</note>
49
+
<para>
50
+
As of dbase 7.0.0 you can use <constant>DBASE_RDONLY</constant>
51
+
and <constant>DBASE_RDWR</constant>, respectively, to specify the
52
+
<parameter>mode</parameter>.
53
+
</para>
50
54
</listitem>
51
55
</varlistentry>
52
56
</variablelist>
53
57
</para>
54
58
</refsect1>
59
+

60
+
<refsect1 role="returnvalues">
61
+
&reftitle.returnvalues;
62
+
<para>
63
+
Returns a database resource on success, &return.falseforfailure;.
64
+
</para>
65
+
</refsect1>
66
+

67
+
<refsect1 role="changelog">
68
+
&reftitle.changelog;
69
+
<informaltable>
70
+
<tgroup cols="2">
71
+
<thead>
72
+
<row>
73
+
<entry>&Version;</entry>
74
+
<entry>&Description;</entry>
75
+
</row>
76
+
</thead>
77
+
<tbody>
78
+
<row>
79
+
<entry>dbase 7.0.0</entry>
80
+
<entry>
81
+
The return value is now a <type>resource</type> instead of an
82
+
<type>int</type>.
83
+
</entry>
84
+
</row>
85
+
</tbody>
86
+
</tgroup>
87
+
</informaltable>
88
+
</refsect1>
89
+

55
90
<refsect1 role="examples">
56
91
&reftitle.examples;
57
92
<para>
...
...
@@ -76,13 +111,7 @@ if ($db) {
76
111
</example>
77
112
</para>
78
113
</refsect1>
79
-
<refsect1 role="returnvalues">
80
-
&reftitle.returnvalues;
81
-
<para>
82
-
Returns a database link identifier if the database is successfully opened,
83
-
or &false; if an error occurred.
84
-
</para>
85
-
</refsect1>
114
+

86
115
<refsect1 role="seealso">
87
116
&reftitle.seealso;
88
117
<para>
89
118