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

dams Wed Apr 25 00:43:39 2001 EDT

  Modified files:
    /phpdoc/en/functions ovrimos.xml
  Log:
  Fixed some return type that didn't match description.Turned some true -> <literal>
  
Index: phpdoc/en/functions/ovrimos.xml
diff -u phpdoc/en/functions/ovrimos.xml:1.3 phpdoc/en/functions/ovrimos.xml:1.4
--- phpdoc/en/functions/ovrimos.xml:1.3 Sat Jan 20 13:08:27 2001
+++ phpdoc/en/functions/ovrimos.xml Wed Apr 25 00:43:39 2001
@@ -166,7 +166,7 @@
      are to be retrieved from long datatypes (long varchar and long
      varbinary). Default is zero. Regardless of its taking a result_id
      as an argument, it currently sets this parameter for all result
- sets. Returns true.
+ sets. Returns <literal>TRUE</literal>.
     </para>
    </refsect1>
   </refentry>
@@ -234,7 +234,7 @@
     <title>Description</title>
     <funcsynopsis>
      <funcprototype>
- <funcdef>int <function>ovrimos_execute</function></funcdef>
+ <funcdef>boolean <function>ovrimos_execute</function></funcdef>
       <paramdef>int <parameter>result_id</parameter></paramdef>
       <paramdef>array
        <parameter><optional>parameters_array</optional></parameter>
@@ -247,7 +247,8 @@
     </para>
     <para>
      <function>ovrimos_execute</function> executes a prepared
- statement. Returns true or false. If the prepared statement
+ statement. Returns <literal>TRUE</literal> or <literal>FALSE</literal>.
+ If the prepared statement
      contained parameters (question marks in the statement), the
      correct number of parameters should be passed in an array. Notice
      that I don't follow the PHP convention of placing just the name
@@ -317,7 +318,7 @@
     <title>Description</title>
     <funcsynopsis>
      <funcprototype>
- <funcdef>int <function>ovrimos_fetch_into</function></funcdef>
+ <funcdef>boolean <function>ovrimos_fetch_into</function></funcdef>
       <paramdef>int <parameter>result_id</parameter></paramdef>
       <paramdef>array <parameter>result_array</parameter></paramdef>
       <paramdef>string
@@ -343,7 +344,7 @@
      and absolute position from the start (essentially equivalent to
      'first' but needs 'rownumber'). Case is not
      significant. 'Rownumber' is optional except for absolute
- positioning. Returns true or false.
+ positioning. Returns <literal>TRUE</literal> or <literal>FALSE</literal>.
     </para>
     <para>
      <example>
@@ -389,7 +390,7 @@
     <title>Description</title>
     <funcsynopsis>
      <funcprototype>
- <funcdef>int <function>ovrimos_fetch_row</function></funcdef>
+ <funcdef>boolean <function>ovrimos_fetch_row</function></funcdef>
       <paramdef>int <parameter>result_id</parameter></paramdef>
       <paramdef>int
        <parameter><optional>how</optional></parameter>
@@ -406,7 +407,7 @@
     <para>
      <function>ovrimos_fetch_row</function> fetches a row from the
      result set. Column values should be retrieved with other
- calls. Returns true or false.
+ calls. Returns <literal>TRUE</literal> or <literal>FALSE</literal>.
     </para>
     <para>
      <example>
@@ -481,7 +482,7 @@
     <title>Description</title>
     <funcsynopsis>
      <funcprototype>
- <funcdef>int <function>ovrimos_result_all</function></funcdef>
+ <funcdef>boolean <function>ovrimos_result_all</function></funcdef>
       <paramdef>int <parameter>result_id</parameter></paramdef>
       <paramdef>string
        <parameter><optional>format</optional></parameter>
@@ -494,7 +495,8 @@
     </para>
     <para>
      <function>ovrimos_result_all</function> prints the whole result
- set as an HTML table. Returns true or false.
+ set as an HTML table. Returns <literal>TRUE</literal> or
+ <literal>FALSE</literal>.
     </para>
     <para>
      <example>
@@ -696,7 +698,8 @@
     </funcsynopsis>
     <para>
      <function>ovrimos_field_len</function> is used to get the length
- of the output column.
+ of the output column with number <parameter>field_number</parameter>,
+ in result <parameter>result_id</parameter>.
     </para>
     <para>
      <function>ovrimos_field_len</function> returns the length of the
@@ -741,7 +744,7 @@
     <title>Description</title>
     <funcsynopsis>
      <funcprototype>
- <funcdef>int <function>ovrimos_free_result</function></funcdef>
+ <funcdef>boolean <function>ovrimos_free_result</function></funcdef>
       <paramdef>int <parameter>result_id</parameter></paramdef>
      </funcprototype>
     </funcsynopsis>
@@ -751,7 +754,7 @@
     </para>
     <para>
      <function>ovrimos_free_result</function> frees the specified
- result_id. Returns true.
+ result_id <parameter>result_id</parameter>. Returns <literal>TRUE</literal>.
     </para>
     </refsect1>
   </refentry>