dams Wed Apr 11 23:39:09 2001 EDT
Modified files:
/phpdoc/en/functions dbx.xml
Log:
Did some rereading.
Index: phpdoc/en/functions/dbx.xml
diff -u phpdoc/en/functions/dbx.xml:1.3 phpdoc/en/functions/dbx.xml:1.4
--- phpdoc/en/functions/dbx.xml:1.3 Wed Apr 11 16:25:17 2001
+++ phpdoc/en/functions/dbx.xml Wed Apr 11 23:39:09 2001
@@ -118,14 +118,14 @@
</para>
<para>
The pgsql support is still experimental, and you should compile
- the actual pgsql module yourself after you modify one of the
+ the actual pgsql module yourself after modifying one of the
source files, otherwise you will get PostgreSQL warnings for
every query.
</para>
<para>
The dbx_link_object has three members, a 'handle', a 'module' and
- a 'database'. The 'database' member is the name of the database
- that is selected. The 'module' member is for internal use by dbx
+ a 'database'. The 'database' member is the name of the currently
+ selected database. The 'module' member is for internal use by dbx
only, and is actually the module number mentioned above. The
'handle' member is a valid handle for the connected database, and
as such can be used in module-specific functions (if required),
@@ -144,7 +144,7 @@
<para>
Host, database, username and password parameters are expected,
but not always used, depending on the connect-functions for the
- module that is abstracted.
+ abstracted module.
</para>
<para>
<example>
@@ -241,7 +241,7 @@
Returns a dbx_result_object or 1 on success (a result object is
only returned for sql-statements that return results) or 0 on
failure. The flags parameter is used to control the amount of
- information that is returned. It can be any combination of the
+ information that is returned. It may be any combination of the
constants DBX_RESULT_INFO, DBX_RESULT_INDEX, DBX_RESULT_ASSOC,
OR-ed together. DBX_RESULT_INFO provides info about columns, such
as field names and field types. DBX_RESULT_INDEX returns the
@@ -255,10 +255,12 @@
effectively only the combinations DBX_RESULT_INDEX,
DBX_RESULT_INDEX | DBX_RESULT_INFO and DBX_RESULT_INDEX |
DBX_RESULT_INFO | DBX_RESULT_ASSOC are possible. This last
- combination is the default if the flags parameter is not
- specified. Associated results are actual references to the
- indexed data, so if you modify data[0][0],
- data[0]['fieldnameforfirstcolumn'] is modified as well.
+ combination is the default if the <parameter>flags</parameter>
+ parameter isn't specified. Associated results are actual
+ references to the indexed data, so if you modify
+ <literal>data[0][0]</literal>, then
+ <literal>data[0]['fieldnameforfirstcolumn']</literal> is
+ modified as well.
</para>
<para>
A dbx_result_object has five members (possibly four depending on
@@ -364,7 +366,8 @@
<refnamediv>
<refname>dbx_sort</refname>
<refpurpose>
- Sort a result from a dbx_query by a custom sort function</refpurpose>
+ Sort a result from a dbx_query by a custom sort function
+ </refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
@@ -378,7 +381,7 @@
</funcprototype>
</funcsynopsis>
<para>
- Returns: <literal>TRUE</literal> on success,
+ Returns <literal>TRUE</literal> on success,
<literal>FALSE</literal> on error.
</para>
<example>
