dbs             Wed Apr 20 15:10:04 2005 EDT

  Modified files:              
    /phpdoc/en/reference/ibm_db2/functions      db2-field-display-size.xml 
                                                db2-field-name.xml 
                                                db2-field-num.xml 
                                                db2-field-precision.xml 
                                                db2-field-scale.xml 
                                                db2-field-type.xml 
                                                db2-field-width.xml 
  Log:
  Initial stab at documenting db2-field* functions (no examples yet).
  
  
http://cvs.php.net/diff.php/phpdoc/en/reference/ibm_db2/functions/db2-field-display-size.xml?r1=1.1&r2=1.2&ty=u
Index: phpdoc/en/reference/ibm_db2/functions/db2-field-display-size.xml
diff -u phpdoc/en/reference/ibm_db2/functions/db2-field-display-size.xml:1.1 
phpdoc/en/reference/ibm_db2/functions/db2-field-display-size.xml:1.2
--- phpdoc/en/reference/ibm_db2/functions/db2-field-display-size.xml:1.1        
Tue Apr 12 17:12:48 2005
+++ phpdoc/en/reference/ibm_db2/functions/db2-field-display-size.xml    Wed Apr 
20 15:10:03 2005
@@ -1,5 +1,5 @@
 <?xml version="1.0" encoding="iso-8859-1"?>
-<!-- $Revision: 1.1 $ -->
+<!-- $Revision: 1.2 $ -->
 <!-- Generated by xml_proto.php v2.2. Found in /scripts directory of phpdoc. 
-->
 <refentry id="function.db2-field-display-size">
  <refnamediv>
@@ -16,7 +16,11 @@
    <methodparam><type>mixed</type><parameter>column</parameter></methodparam>
   </methodsynopsis>
 
-  &warn.undocumented.func;
+  &warn.experimental.func;
+  <para>
+   Returns the maximum number of bytes required to display a column in a
+   result set.
+  </para>
 
  </refsect1>
  <refsect1 role="parameters">
@@ -27,7 +31,7 @@
      <term><parameter>stmt</parameter></term>
       <listitem>
        <para>
-        Its description
+        Specifies a statement resource containing a result set.
        </para>
       </listitem>
      </varlistentry>
@@ -35,7 +39,9 @@
      <term><parameter>column</parameter></term>
       <listitem>
        <para>
-        Its description
+        Specifies the column in the result set. This can either be an integer
+        representing the 0-indexed position of the column, or a string
+        containing the name of the column.
        </para>
       </listitem>
      </varlistentry>
@@ -45,45 +51,11 @@
  <refsect1 role="returnvalues">
   &reftitle.returnvalues;
   <para>
-   What the function returns, first on success, then on failure. See
-   also the &return.success; entity
-  </para>
- </refsect1>
-
- <!-- Use when EXCEPTIONS exist
- <refsect1 role="exceptions">
-  &reftitle.exceptions;
-  <para>
-   When does this function throw exceptions?
-  </para>
- </refsect1>
- -->
-
-
- <!-- Use when a CHANGELOG exists
- <refsect1 role="changelog">
-  &reftitle.changelog;
-  <para>
-   <informaltable>
-    <tgroup cols="2">
-     <thead>
-      <row>
-       <entry>&Version;</entry>
-       <entry>&Description</entry>
-      </row>
-     </thead>
-     <tbody>
-      <row>
-       <entry>Enter the PHP version of change here
-       <entry>Description of change
-      </row>
-     </tbody>
-    </tgroup>
-   </informaltable>
+   Returns an integer value with the maximum number of bytes required to
+   display the specified column. If the column does not exist in the result
+   set, <function>db2_field_display_size</function> returns &false;.
   </para>
  </refsect1>
- -->
-
 
  <!-- Use when examples exist
  <refsect1 role="examples">
@@ -116,18 +88,19 @@
  </refsect1>
  -->
 
-
- <!-- Use when adding See Also links
  <refsect1 role="seealso">
   &reftitle.seealso;
   <para>
    <simplelist>
-    <member><function></function></member>
-    <member>Or <link linkend="somethingelse">something else</link></member>
+    <member><function>db2-field-name</function></member>
+    <member><function>db2-field-num</function></member>
+    <member><function>db2-field-precision</function></member>
+    <member><function>db2-field-scale</function></member>
+    <member><function>db2-field-type</function></member>
+    <member><function>db2-field-width</function></member>
    </simplelist>
   </para>
  </refsect1>
- -->
 
 
 </refentry>
http://cvs.php.net/diff.php/phpdoc/en/reference/ibm_db2/functions/db2-field-name.xml?r1=1.1&r2=1.2&ty=u
Index: phpdoc/en/reference/ibm_db2/functions/db2-field-name.xml
diff -u phpdoc/en/reference/ibm_db2/functions/db2-field-name.xml:1.1 
phpdoc/en/reference/ibm_db2/functions/db2-field-name.xml:1.2
--- phpdoc/en/reference/ibm_db2/functions/db2-field-name.xml:1.1        Tue Apr 
12 17:12:48 2005
+++ phpdoc/en/reference/ibm_db2/functions/db2-field-name.xml    Wed Apr 20 
15:10:03 2005
@@ -1,5 +1,5 @@
 <?xml version="1.0" encoding="iso-8859-1"?>
-<!-- $Revision: 1.1 $ -->
+<!-- $Revision: 1.2 $ -->
 <!-- Generated by xml_proto.php v2.2. Found in /scripts directory of phpdoc. 
-->
 <refentry id="function.db2-field-name">
  <refnamediv>
@@ -16,7 +16,10 @@
    <methodparam><type>mixed</type><parameter>column</parameter></methodparam>
   </methodsynopsis>
 
-  &warn.undocumented.func;
+  &warn.experimental.func;
+  <para>
+   Returns the name of the specified column in the result set.
+  </para>
 
  </refsect1>
  <refsect1 role="parameters">
@@ -27,7 +30,7 @@
      <term><parameter>stmt</parameter></term>
       <listitem>
        <para>
-        Its description
+        Specifies a statement resource containing a result set.
        </para>
       </listitem>
      </varlistentry>
@@ -35,7 +38,9 @@
      <term><parameter>column</parameter></term>
       <listitem>
        <para>
-        Its description
+        Specifies the column in the result set. This can either be an integer
+        representing the 0-indexed position of the column, or a string
+        containing the name of the column.
        </para>
       </listitem>
      </varlistentry>
@@ -45,45 +50,11 @@
  <refsect1 role="returnvalues">
   &reftitle.returnvalues;
   <para>
-   What the function returns, first on success, then on failure. See
-   also the &return.success; entity
-  </para>
- </refsect1>
-
- <!-- Use when EXCEPTIONS exist
- <refsect1 role="exceptions">
-  &reftitle.exceptions;
-  <para>
-   When does this function throw exceptions?
-  </para>
- </refsect1>
- -->
-
-
- <!-- Use when a CHANGELOG exists
- <refsect1 role="changelog">
-  &reftitle.changelog;
-  <para>
-   <informaltable>
-    <tgroup cols="2">
-     <thead>
-      <row>
-       <entry>&Version;</entry>
-       <entry>&Description</entry>
-      </row>
-     </thead>
-     <tbody>
-      <row>
-       <entry>Enter the PHP version of change here
-       <entry>Description of change
-      </row>
-     </tbody>
-    </tgroup>
-   </informaltable>
+   Returns a string containing the name of the specified column. If the
+   specified column does not exist in the result
+   set, <function>db2_field_name</function> returns &false;.
   </para>
  </refsect1>
- -->
-
 
  <!-- Use when examples exist
  <refsect1 role="examples">
@@ -116,18 +87,19 @@
  </refsect1>
  -->
 
-
- <!-- Use when adding See Also links
  <refsect1 role="seealso">
   &reftitle.seealso;
   <para>
    <simplelist>
-    <member><function></function></member>
-    <member>Or <link linkend="somethingelse">something else</link></member>
+    <member><function>db2-field-display-size</function></member>
+    <member><function>db2-field-num</function></member>
+    <member><function>db2-field-precision</function></member>
+    <member><function>db2-field-scale</function></member>
+    <member><function>db2-field-type</function></member>
+    <member><function>db2-field-width</function></member>
    </simplelist>
   </para>
  </refsect1>
- -->
 
 
 </refentry>
http://cvs.php.net/diff.php/phpdoc/en/reference/ibm_db2/functions/db2-field-num.xml?r1=1.1&r2=1.2&ty=u
Index: phpdoc/en/reference/ibm_db2/functions/db2-field-num.xml
diff -u phpdoc/en/reference/ibm_db2/functions/db2-field-num.xml:1.1 
phpdoc/en/reference/ibm_db2/functions/db2-field-num.xml:1.2
--- phpdoc/en/reference/ibm_db2/functions/db2-field-num.xml:1.1 Tue Apr 12 
17:12:48 2005
+++ phpdoc/en/reference/ibm_db2/functions/db2-field-num.xml     Wed Apr 20 
15:10:03 2005
@@ -1,5 +1,5 @@
 <?xml version="1.0" encoding="iso-8859-1"?>
-<!-- $Revision: 1.1 $ -->
+<!-- $Revision: 1.2 $ -->
 <!-- Generated by xml_proto.php v2.2. Found in /scripts directory of phpdoc. 
-->
 <refentry id="function.db2-field-num">
  <refnamediv>
@@ -16,7 +16,10 @@
    <methodparam><type>mixed</type><parameter>column</parameter></methodparam>
   </methodsynopsis>
 
-  &warn.undocumented.func;
+  &warn.experimental.func;
+  <para>
+   Returns the position of the named column in a result set.
+  </para>
 
  </refsect1>
  <refsect1 role="parameters">
@@ -27,7 +30,7 @@
      <term><parameter>stmt</parameter></term>
       <listitem>
        <para>
-        Its description
+        Specifies a statement resource containing a result set.
        </para>
       </listitem>
      </varlistentry>
@@ -35,7 +38,9 @@
      <term><parameter>column</parameter></term>
       <listitem>
        <para>
-        Its description
+        Specifies the column in the result set. This can either be an integer
+        representing the 0-indexed position of the column, or a string
+        containing the name of the column.
        </para>
       </listitem>
      </varlistentry>
@@ -45,46 +50,12 @@
  <refsect1 role="returnvalues">
   &reftitle.returnvalues;
   <para>
-   What the function returns, first on success, then on failure. See
-   also the &return.success; entity
+   Returns an integer containing the 0-indexed position of the named column in
+   the result set. If the specified column does not exist in the result set,
+   <function>db2_field_num</function> returns &false;.
   </para>
  </refsect1>
 
- <!-- Use when EXCEPTIONS exist
- <refsect1 role="exceptions">
-  &reftitle.exceptions;
-  <para>
-   When does this function throw exceptions?
-  </para>
- </refsect1>
- -->
-
-
- <!-- Use when a CHANGELOG exists
- <refsect1 role="changelog">
-  &reftitle.changelog;
-  <para>
-   <informaltable>
-    <tgroup cols="2">
-     <thead>
-      <row>
-       <entry>&Version;</entry>
-       <entry>&Description</entry>
-      </row>
-     </thead>
-     <tbody>
-      <row>
-       <entry>Enter the PHP version of change here
-       <entry>Description of change
-      </row>
-     </tbody>
-    </tgroup>
-   </informaltable>
-  </para>
- </refsect1>
- -->
-
-
  <!-- Use when examples exist
  <refsect1 role="examples">
   &reftitle.examples;
@@ -116,19 +87,19 @@
  </refsect1>
  -->
 
-
- <!-- Use when adding See Also links
  <refsect1 role="seealso">
   &reftitle.seealso;
   <para>
    <simplelist>
-    <member><function></function></member>
-    <member>Or <link linkend="somethingelse">something else</link></member>
+    <member><function>db2-field-display-size</function></member>
+    <member><function>db2-field-name</function></member>
+    <member><function>db2-field-precision</function></member>
+    <member><function>db2-field-scale</function></member>
+    <member><function>db2-field-type</function></member>
+    <member><function>db2-field-width</function></member>
    </simplelist>
   </para>
  </refsect1>
- -->
-
 
 </refentry>
 
http://cvs.php.net/diff.php/phpdoc/en/reference/ibm_db2/functions/db2-field-precision.xml?r1=1.1&r2=1.2&ty=u
Index: phpdoc/en/reference/ibm_db2/functions/db2-field-precision.xml
diff -u phpdoc/en/reference/ibm_db2/functions/db2-field-precision.xml:1.1 
phpdoc/en/reference/ibm_db2/functions/db2-field-precision.xml:1.2
--- phpdoc/en/reference/ibm_db2/functions/db2-field-precision.xml:1.1   Tue Apr 
12 17:12:48 2005
+++ phpdoc/en/reference/ibm_db2/functions/db2-field-precision.xml       Wed Apr 
20 15:10:03 2005
@@ -1,11 +1,11 @@
 <?xml version="1.0" encoding="iso-8859-1"?>
-<!-- $Revision: 1.1 $ -->
+<!-- $Revision: 1.2 $ -->
 <!-- Generated by xml_proto.php v2.2. Found in /scripts directory of phpdoc. 
-->
 <refentry id="function.db2-field-precision">
  <refnamediv>
   <refname>db2_field_precision</refname>
   <refpurpose>
-   Returns the precision for the indicated column in a result set
+   Returns the precision of the indicated column in a result set
   </refpurpose>
  </refnamediv>
  <refsect1 role="description">
@@ -16,7 +16,10 @@
    <methodparam><type>mixed</type><parameter>column</parameter></methodparam>
   </methodsynopsis>
 
-  &warn.undocumented.func;
+  &warn.experimental.func;
+  <para>
+   Returns the precision of the indicated column in a result set.
+  </para>
 
  </refsect1>
  <refsect1 role="parameters">
@@ -27,7 +30,7 @@
      <term><parameter>stmt</parameter></term>
       <listitem>
        <para>
-        Its description
+        Specifies a statement resource containing a result set.
        </para>
       </listitem>
      </varlistentry>
@@ -35,7 +38,9 @@
      <term><parameter>column</parameter></term>
       <listitem>
        <para>
-        Its description
+        Specifies the column in the result set. This can either be an integer
+        representing the 0-indexed position of the column, or a string
+        containing the name of the column.
        </para>
       </listitem>
      </varlistentry>
@@ -45,46 +50,12 @@
  <refsect1 role="returnvalues">
   &reftitle.returnvalues;
   <para>
-   What the function returns, first on success, then on failure. See
-   also the &return.success; entity
+   Returns an integer containing the precision of the specified column. If the
+   specified column does not exist in the result set,
+   <function>db2_field_precision</function> returns &false;.
   </para>
  </refsect1>
 
- <!-- Use when EXCEPTIONS exist
- <refsect1 role="exceptions">
-  &reftitle.exceptions;
-  <para>
-   When does this function throw exceptions?
-  </para>
- </refsect1>
- -->
-
-
- <!-- Use when a CHANGELOG exists
- <refsect1 role="changelog">
-  &reftitle.changelog;
-  <para>
-   <informaltable>
-    <tgroup cols="2">
-     <thead>
-      <row>
-       <entry>&Version;</entry>
-       <entry>&Description</entry>
-      </row>
-     </thead>
-     <tbody>
-      <row>
-       <entry>Enter the PHP version of change here
-       <entry>Description of change
-      </row>
-     </tbody>
-    </tgroup>
-   </informaltable>
-  </para>
- </refsect1>
- -->
-
-
  <!-- Use when examples exist
  <refsect1 role="examples">
   &reftitle.examples;
@@ -116,19 +87,19 @@
  </refsect1>
  -->
 
-
- <!-- Use when adding See Also links
  <refsect1 role="seealso">
   &reftitle.seealso;
   <para>
    <simplelist>
-    <member><function></function></member>
-    <member>Or <link linkend="somethingelse">something else</link></member>
+    <member><function>db2-field-display-size</function></member>
+    <member><function>db2-field-name</function></member>
+    <member><function>db2-field-num</function></member>
+    <member><function>db2-field-scale</function></member>
+    <member><function>db2-field-type</function></member>
+    <member><function>db2-field-width</function></member>
    </simplelist>
   </para>
  </refsect1>
- -->
-
 
 </refentry>
 
http://cvs.php.net/diff.php/phpdoc/en/reference/ibm_db2/functions/db2-field-scale.xml?r1=1.1&r2=1.2&ty=u
Index: phpdoc/en/reference/ibm_db2/functions/db2-field-scale.xml
diff -u phpdoc/en/reference/ibm_db2/functions/db2-field-scale.xml:1.1 
phpdoc/en/reference/ibm_db2/functions/db2-field-scale.xml:1.2
--- phpdoc/en/reference/ibm_db2/functions/db2-field-scale.xml:1.1       Tue Apr 
12 17:12:48 2005
+++ phpdoc/en/reference/ibm_db2/functions/db2-field-scale.xml   Wed Apr 20 
15:10:03 2005
@@ -1,5 +1,5 @@
 <?xml version="1.0" encoding="iso-8859-1"?>
-<!-- $Revision: 1.1 $ -->
+<!-- $Revision: 1.2 $ -->
 <!-- Generated by xml_proto.php v2.2. Found in /scripts directory of phpdoc. 
-->
 <refentry id="function.db2-field-scale">
  <refnamediv>
@@ -16,7 +16,10 @@
    <methodparam><type>mixed</type><parameter>column</parameter></methodparam>
   </methodsynopsis>
 
-  &warn.undocumented.func;
+  &warn.experimental.func;
+  <para>
+   Returns the scale of the indicated column in a result set.
+  </para>
 
  </refsect1>
  <refsect1 role="parameters">
@@ -27,7 +30,7 @@
      <term><parameter>stmt</parameter></term>
       <listitem>
        <para>
-        Its description
+        Specifies a statement resource containing a result set.
        </para>
       </listitem>
      </varlistentry>
@@ -35,7 +38,9 @@
      <term><parameter>column</parameter></term>
       <listitem>
        <para>
-        Its description
+        Specifies the column in the result set. This can either be an integer
+        representing the 0-indexed position of the column, or a string
+        containing the name of the column.
        </para>
       </listitem>
      </varlistentry>
@@ -45,46 +50,12 @@
  <refsect1 role="returnvalues">
   &reftitle.returnvalues;
   <para>
-   What the function returns, first on success, then on failure. See
-   also the &return.success; entity
+   Returns an integer containing the precision of the specified column. If the
+   specified column does not exist in the result set,
+   <function>db2_field_scale</function> returns &false;.
   </para>
  </refsect1>
 
- <!-- Use when EXCEPTIONS exist
- <refsect1 role="exceptions">
-  &reftitle.exceptions;
-  <para>
-   When does this function throw exceptions?
-  </para>
- </refsect1>
- -->
-
-
- <!-- Use when a CHANGELOG exists
- <refsect1 role="changelog">
-  &reftitle.changelog;
-  <para>
-   <informaltable>
-    <tgroup cols="2">
-     <thead>
-      <row>
-       <entry>&Version;</entry>
-       <entry>&Description</entry>
-      </row>
-     </thead>
-     <tbody>
-      <row>
-       <entry>Enter the PHP version of change here
-       <entry>Description of change
-      </row>
-     </tbody>
-    </tgroup>
-   </informaltable>
-  </para>
- </refsect1>
- -->
-
-
  <!-- Use when examples exist
  <refsect1 role="examples">
   &reftitle.examples;
@@ -116,19 +87,19 @@
  </refsect1>
  -->
 
-
- <!-- Use when adding See Also links
  <refsect1 role="seealso">
   &reftitle.seealso;
   <para>
    <simplelist>
-    <member><function></function></member>
-    <member>Or <link linkend="somethingelse">something else</link></member>
+    <member><function>db2-field-display-size</function></member>
+    <member><function>db2-field-name</function></member>
+    <member><function>db2-field-num</function></member>
+    <member><function>db2-field-precision</function></member>
+    <member><function>db2-field-type</function></member>
+    <member><function>db2-field-width</function></member>
    </simplelist>
   </para>
  </refsect1>
- -->
-
 
 </refentry>
 
http://cvs.php.net/diff.php/phpdoc/en/reference/ibm_db2/functions/db2-field-type.xml?r1=1.1&r2=1.2&ty=u
Index: phpdoc/en/reference/ibm_db2/functions/db2-field-type.xml
diff -u phpdoc/en/reference/ibm_db2/functions/db2-field-type.xml:1.1 
phpdoc/en/reference/ibm_db2/functions/db2-field-type.xml:1.2
--- phpdoc/en/reference/ibm_db2/functions/db2-field-type.xml:1.1        Tue Apr 
12 17:12:48 2005
+++ phpdoc/en/reference/ibm_db2/functions/db2-field-type.xml    Wed Apr 20 
15:10:03 2005
@@ -1,5 +1,5 @@
 <?xml version="1.0" encoding="iso-8859-1"?>
-<!-- $Revision: 1.1 $ -->
+<!-- $Revision: 1.2 $ -->
 <!-- Generated by xml_proto.php v2.2. Found in /scripts directory of phpdoc. 
-->
 <refentry id="function.db2-field-type">
  <refnamediv>
@@ -16,7 +16,10 @@
    <methodparam><type>mixed</type><parameter>column</parameter></methodparam>
   </methodsynopsis>
 
-  &warn.undocumented.func;
+  &warn.experimental.func;
+  <para>
+   Returns the data type of the indicated column in a result set.
+  </para>
 
  </refsect1>
  <refsect1 role="parameters">
@@ -27,7 +30,7 @@
      <term><parameter>stmt</parameter></term>
       <listitem>
        <para>
-        Its description
+        Specifies a statement resource containing a result set.
        </para>
       </listitem>
      </varlistentry>
@@ -35,7 +38,9 @@
      <term><parameter>column</parameter></term>
       <listitem>
        <para>
-        Its description
+        Specifies the column in the result set. This can either be an integer
+        representing the 0-indexed position of the column, or a string
+        containing the name of the column.
        </para>
       </listitem>
      </varlistentry>
@@ -45,46 +50,12 @@
  <refsect1 role="returnvalues">
   &reftitle.returnvalues;
   <para>
-   What the function returns, first on success, then on failure. See
-   also the &return.success; entity
+   Returns a string containing the defined data type of the specified column.
+   If the specified column does not exist in the result set,
+   <function>db2_field_type</function> returns &false;.
   </para>
  </refsect1>
 
- <!-- Use when EXCEPTIONS exist
- <refsect1 role="exceptions">
-  &reftitle.exceptions;
-  <para>
-   When does this function throw exceptions?
-  </para>
- </refsect1>
- -->
-
-
- <!-- Use when a CHANGELOG exists
- <refsect1 role="changelog">
-  &reftitle.changelog;
-  <para>
-   <informaltable>
-    <tgroup cols="2">
-     <thead>
-      <row>
-       <entry>&Version;</entry>
-       <entry>&Description</entry>
-      </row>
-     </thead>
-     <tbody>
-      <row>
-       <entry>Enter the PHP version of change here
-       <entry>Description of change
-      </row>
-     </tbody>
-    </tgroup>
-   </informaltable>
-  </para>
- </refsect1>
- -->
-
-
  <!-- Use when examples exist
  <refsect1 role="examples">
   &reftitle.examples;
@@ -116,19 +87,19 @@
  </refsect1>
  -->
 
-
- <!-- Use when adding See Also links
  <refsect1 role="seealso">
   &reftitle.seealso;
   <para>
    <simplelist>
-    <member><function></function></member>
-    <member>Or <link linkend="somethingelse">something else</link></member>
+    <member><function>db2-field-display-size</function></member>
+    <member><function>db2-field-name</function></member>
+    <member><function>db2-field-num</function></member>
+    <member><function>db2-field-precision</function></member>
+    <member><function>db2-field-scale</function></member>
+    <member><function>db2-field-width</function></member>
    </simplelist>
   </para>
  </refsect1>
- -->
-
 
 </refentry>
 
http://cvs.php.net/diff.php/phpdoc/en/reference/ibm_db2/functions/db2-field-width.xml?r1=1.1&r2=1.2&ty=u
Index: phpdoc/en/reference/ibm_db2/functions/db2-field-width.xml
diff -u phpdoc/en/reference/ibm_db2/functions/db2-field-width.xml:1.1 
phpdoc/en/reference/ibm_db2/functions/db2-field-width.xml:1.2
--- phpdoc/en/reference/ibm_db2/functions/db2-field-width.xml:1.1       Tue Apr 
12 17:12:48 2005
+++ phpdoc/en/reference/ibm_db2/functions/db2-field-width.xml   Wed Apr 20 
15:10:03 2005
@@ -1,5 +1,5 @@
 <?xml version="1.0" encoding="iso-8859-1"?>
-<!-- $Revision: 1.1 $ -->
+<!-- $Revision: 1.2 $ -->
 <!-- Generated by xml_proto.php v2.2. Found in /scripts directory of phpdoc. 
-->
 <refentry id="function.db2-field-width">
  <refnamediv>
@@ -16,7 +16,12 @@
    <methodparam><type>mixed</type><parameter>column</parameter></methodparam>
   </methodsynopsis>
 
-  &warn.undocumented.func;
+  &warn.experimental.func;
+  <para>
+   Returns the width of the current value of the indicated column in a result
+   set. This is the maximum width of the column for a fixed-length data type,
+   or the actual width of the column for a variable-length data type. 
+  </para>
 
  </refsect1>
  <refsect1 role="parameters">
@@ -27,7 +32,7 @@
      <term><parameter>stmt</parameter></term>
       <listitem>
        <para>
-        Its description
+        Specifies a statement resource containing a result set.
        </para>
       </listitem>
      </varlistentry>
@@ -35,7 +40,9 @@
      <term><parameter>column</parameter></term>
       <listitem>
        <para>
-        Its description
+        Specifies the column in the result set. This can either be an integer
+        representing the 0-indexed position of the column, or a string
+        containing the name of the column.
        </para>
       </listitem>
      </varlistentry>
@@ -45,46 +52,13 @@
  <refsect1 role="returnvalues">
   &reftitle.returnvalues;
   <para>
-   What the function returns, first on success, then on failure. See
-   also the &return.success; entity
+   Returns an integer containing the width of the specified character or
+   binary data type column in a result set. If the specified column does not
+   exist in the result set, <function>db2_field_width</function> returns
+   &false;.
   </para>
  </refsect1>
 
- <!-- Use when EXCEPTIONS exist
- <refsect1 role="exceptions">
-  &reftitle.exceptions;
-  <para>
-   When does this function throw exceptions?
-  </para>
- </refsect1>
- -->
-
-
- <!-- Use when a CHANGELOG exists
- <refsect1 role="changelog">
-  &reftitle.changelog;
-  <para>
-   <informaltable>
-    <tgroup cols="2">
-     <thead>
-      <row>
-       <entry>&Version;</entry>
-       <entry>&Description</entry>
-      </row>
-     </thead>
-     <tbody>
-      <row>
-       <entry>Enter the PHP version of change here
-       <entry>Description of change
-      </row>
-     </tbody>
-    </tgroup>
-   </informaltable>
-  </para>
- </refsect1>
- -->
-
-
  <!-- Use when examples exist
  <refsect1 role="examples">
   &reftitle.examples;
@@ -116,19 +90,19 @@
  </refsect1>
  -->
 
-
- <!-- Use when adding See Also links
  <refsect1 role="seealso">
   &reftitle.seealso;
   <para>
    <simplelist>
-    <member><function></function></member>
-    <member>Or <link linkend="somethingelse">something else</link></member>
+    <member><function>db2-field-display-size</function></member>
+    <member><function>db2-field-name</function></member>
+    <member><function>db2-field-num</function></member>
+    <member><function>db2-field-precision</function></member>
+    <member><function>db2-field-scale</function></member>
+    <member><function>db2-field-type</function></member>
    </simplelist>
   </para>
  </refsect1>
- -->
-
 
 </refentry>
 

Reply via email to