php-doc-en/reference/maxdb/functions/maxdb-fetch-field.xml

<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.6 $ -->
<refentry xmlns="http://docbook.org/ns/docbook" xml:id="function.maxdb-fetch-field">
 <refnamediv>
  <refname>maxdb_fetch_field</refname>
  <refname>result->fetch_field</refname>
  <refpurpose>Returns the next field in the result set</refpurpose>
 </refnamediv>

 <refsect1 role="description">
  &reftitle.description;
  <para>Procedural style:</para>
  <methodsynopsis>
   <type>mixed</type><methodname>maxdb_fetch_field</methodname>
   <methodparam><type>resource</type><parameter>result</parameter></methodparam>
  </methodsynopsis>
  <para>Object oriented style (method):</para>
  <classsynopsis>
   <ooclass><classname>result</classname></ooclass>
   <methodsynopsis>
    <type>mixed</type><methodname>fetch_field</methodname>
    <void/>
   </methodsynopsis>
  </classsynopsis>
  <para>
   The <function>maxdb_fetch_field</function> returns the definition of one column
   of a result set as an resource. Call this function repeatedly to retrieve
   information about all columns in the result set.
   <function>maxdb_fetch_field</function> returns &false; when no more fields
   are left.
  </para>
 </refsect1>

 <refsect1 role="returnvalues">
  &reftitle.returnvalues;
  <para>
   Returns an resource which contains field definition informations or &false; if no field information
   is available.
  </para>
  <para>
  <table>
   <title>Object properties</title>
   <tgroup cols='2'>
    <thead>
     <row>
      <entry>Property</entry>
      <entry>Description</entry>
     </row>
    </thead>
    <tbody>
     <row>
      <entry>name</entry>
      <entry>The name of the column</entry>
     </row>
     <row>
      <entry>max_length</entry>
      <entry>The maximum width of the field for the result set.</entry>
     </row>
     <row>
      <entry>type</entry>
      <entry>The data type used for this field</entry>
     </row>
     <row>
      <entry>decimals</entry>
      <entry>The number of decimals used (for integer fields)</entry>
     </row>
    </tbody>
   </tgroup>
  </table>
  </para>
 </refsect1>

 <refsect1 role="examples">
  &reftitle.examples;
  <example>
   <title>Object oriented style</title>
   <programlisting role="php">
<![CDATA[
<?php
$maxdb = new maxdb("localhost", "MONA", "RED", "DEMODB");

/* check connection */
if (maxdb_connect_errno()) {
   printf("Connect failed: %s\n", maxdb_connect_error());
   exit();
}

$query = "SELECT name, cno from hotel.customer ORDER BY cno";

if ($result = $maxdb->query($query)) {

   /* Get field information for all columns */
   while ($finfo = $result->fetch_field()) {

       printf("Name:     %s\n", $finfo->name);
       printf("Table:    %s\n", $finfo->table);
       printf("max. Len: %d\n", $finfo->max_length);
       printf("Flags:    %d\n", $finfo->flags);
       printf("Type:     %d\n\n", $finfo->type);
   }
   $result->close();
}

/* close connection */
$maxdb->close();
?>
]]>
   </programlisting>
  </example>
  <example>
   <title>Procedural style</title>
   <programlisting role="php">
<![CDATA[
<?php
$link = maxdb_connect("localhost", "MONA", "RED", "DEMODB");

/* check connection */
if (maxdb_connect_errno()) {
   printf("Connect failed: %s\n", maxdb_connect_error());
   exit();
}

$query = "SELECT name, cno from hotel.customer ORDER BY cno";

if ($result = maxdb_query($link, $query)) {

   /* Get field information for all fields */
   while ($finfo = maxdb_fetch_field($result)) {

       printf("Name:     %s\n", $finfo->name);
       printf("Table:    %s\n", $finfo->table);
       printf("max. Len: %d\n", $finfo->max_length);
       printf("Flags:    %d\n", $finfo->flags);
       printf("Type:     %d\n\n", $finfo->type);
   }
   maxdb_free_result($result);
}

/* close connection */
maxdb_close($link);
?>
]]>
   </programlisting>
  </example>
  <para>
   The above examples would produce the following output:
  </para>
  <screen>
<![CDATA[
Name:     NAME
Table:
max. Len: 10
Flags:    -1
Type:     2

Name:     CNO
Table:
max. Len: 4
Flags:    -1
Type:     0
]]>
  </screen>
 </refsect1>

 <refsect1 role="seealso">
  &reftitle.seealso;
  <para>
   <simplelist>
    <member><function>maxdb_num_fields</function></member>
    <member><function>maxdb_fetch_field_direct</function></member>
    <member><function>maxdb_fetch_fields</function></member>
    <member><function>maxdb_field_seek</function></member>
   </simplelist>
  </para>
 </refsect1>

</refentry>

<!-- Keep this comment at the end of the file
Local variables:
mode: sgml
sgml-omittag:t
sgml-shorttag:t
sgml-minimize-attributes:nil
sgml-always-quote-attributes:t
sgml-indent-step:1
sgml-indent-data:t
indent-tabs-mode:nil
sgml-parent-document:nil
sgml-default-dtd-file:"../../../../manual.ced"
sgml-exposed-tags:nil
sgml-local-catalogs:nil
sgml-local-ecat-files:nil
End:
vim600: syn=xml fen fdm=syntax fdl=2 si
vim: et tw=78 syn=sgml
vi: ts=1 sw=1
-->