[PHP-DOC] cvs: phpdoc /en/functions dbx.xml From: Damien Seguy (dams <email protected>)
Date: 04/12/01

dams Thu Apr 12 02:06:49 2001 EDT

  Modified files:
    /phpdoc/en/functions dbx.xml
  Log:
  Changed some return types.
  
Index: phpdoc/en/functions/dbx.xml
diff -u phpdoc/en/functions/dbx.xml:1.4 phpdoc/en/functions/dbx.xml:1.5
--- phpdoc/en/functions/dbx.xml:1.4 Wed Apr 11 23:39:09 2001
+++ phpdoc/en/functions/dbx.xml Thu Apr 12 02:06:49 2001
@@ -34,7 +34,7 @@
     <title>Description</title>
     <funcsynopsis>
      <funcprototype>
- <funcdef>int <function>dbx_close</function></funcdef>
+ <funcdef>boolean <function>dbx_close</function></funcdef>
       <paramdef>dbx_link_object
        <parameter>link_identifier</parameter>
       </paramdef>
@@ -240,7 +240,8 @@
     <para>
      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
+ failure. The <parameter>flags</parameter> parameter is used to
+ control the amount of
      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
@@ -249,7 +250,8 @@
      row (or record) number and 3 is the column (or field) number),
      where the first row and column are indexed at 0. DBX_RESULT_ASSOC
      associates the column indices with field names. Note that
- DBX_RESULT_INDEX is always returned, regardless of the flags
+ DBX_RESULT_INDEX is always returned, regardless of the
+ <parameter>flags</parameter>
      parameter. If DBX_RESULT_ASSOC is specified, DBX_RESULT_INFO is
      also returned even if it wasn't specified. This means that
      effectively only the combinations DBX_RESULT_INDEX,
@@ -264,10 +266,10 @@
     </para>
     <para>
      A dbx_result_object has five members (possibly four depending on
- the flags), 'handle', 'cols', 'rows', 'info' (optional) and
- 'data'. Handle is a valid result identifier for the specified
- module, and as such can be used in module-specific functions, as
- seen in the example:
+ <parameter>flags</parameter>), 'handle', 'cols', 'rows', 'info'
+ (optional) and 'data'. Handle is a valid result identifier for
+ the specified module, and as such can be used in module-specific
+ functions, as seen in the example:
     </para>
     <para>
      <informalexample role="php">
@@ -291,8 +293,8 @@
     </para>
     <para>
      The info member is only returned if DBX_RESULT_INFO and/or
- DBX_RESULT_ASSOC are specified in the flags parameter. It is a 2d
- array, that has two named rows ("name" and "type") to retrieve
+ DBX_RESULT_ASSOC are specified in the <parameter>flags</parameter> parameter.
+ It is a 2d array, that has two named rows ("name" and "type") to retrieve
      column information, e.g.
     </para>
     <para>
@@ -373,7 +375,7 @@
     <title>Description</title>
     <funcsynopsis>
      <funcprototype>
- <funcdef>int <function>dbx_sort</function></funcdef>
+ <funcdef>boolean <function>dbx_sort</function></funcdef>
       <paramdef>dbx_result_object <parameter>result</parameter></paramdef>
       <paramdef>string
        <parameter>user_compare_function</parameter>