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

<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.17 $ -->
  <refentry id="function.mysqli-fetch-field">
   <refnamediv>
    <refname>mysqli_fetch_field</refname>
    <refname>result->fetch_field</refname>
    <refpurpose>Returns the next field in the result set</refpurpose>
   </refnamediv>
   <refsect1>
    <title>Description</title>
    <para>Procedural style:</para>
    <methodsynopsis>
     <type>object</type><methodname>mysqli_fetch_field</methodname>
     <methodparam><type>mysqli_result</type><parameter>result</parameter></methodparam>
    </methodsynopsis>
    <para>Object oriented style (method):</para>
    <classsynopsis>
     <ooclass><classname>mysqli_result</classname></ooclass>
     <methodsynopsis>
      <type>object</type><methodname>fetch_field</methodname>
      <void/>
     </methodsynopsis>
    </classsynopsis>
    <para>
     The <function>mysqli_fetch_field</function> returns the definition of one column 
     of a result set as an object. Call this function repeatedly to retrieve 
     information about all columns in the result set. 
     <function>mysqli_fetch_field</function> returns &false; when no more fields 
     are left. 
    </para>
   </refsect1>
   <refsect1>
    &reftitle.returnvalues;
    <para>
     Returns an object which contains field definition information 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>orgname</entry>
        <entry>Original column name if an alias was specified</entry>
       </row>
       <row>
        <entry>table</entry>
        <entry>The name of the table this field belongs to (if not calculated)</entry>
       </row>
       <row>
        <entry>orgtable</entry>
        <entry>Original table name if an alias was specified</entry>
       </row>
       <row>
        <entry>def</entry>
        <entry>The default value for this field, represented as a string</entry>
       </row>
       <row>       
        <entry>max_length</entry>
        <entry>The maximum width of the field for the result set.</entry>
       </row>
       <row>
        <entry>flags</entry>
        <entry>An integer representing the bit-flags for the field.</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>
    &reftitle.seealso;
    <para>
     <function>mysqli_num_fields</function>,
     <function>mysqli_fetch_field_direct</function>,
     <function>mysqli_fetch_fields</function>&listendand;
     <function>mysqli_field_seek</function>.
    </para>
   </refsect1>
   <refsect1>
    &reftitle.examples;
    <example>
     <title>Object oriented style</title>
     <programlisting role="php">
<![CDATA[
<?php
$mysqli = new mysqli("localhost", "my_user", "my_password", "world");

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

$query = "SELECT Name, SurfaceArea from Country ORDER BY Code LIMIT 5";

if ($result = $mysqli->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 */
$mysqli->close();
?>
]]>
    </programlisting>
    </example>
    <example>
     <title>Procedural style</title>
     <programlisting role="php">
<![CDATA[
<?php
$link = mysqli_connect("localhost", "my_user", "my_password", "world");

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

$query = "SELECT Name, SurfaceArea from Country ORDER BY Code LIMIT 5";

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

    /* Get field information for all fields */
    while ($finfo = mysqli_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);
    }
    mysqli_free_result($result);
}

/* close connection */
mysqli_close($link);
?>
]]>
     </programlisting>
    </example>
    &example.outputs;
    <screen>
<![CDATA[
Name:     Name
Table:    Country
max. Len: 11
Flags:    1
Type:     254

Name:     SurfaceArea
Table:    Country
max. Len: 10
Flags:    32769
Type:     4

]]>
    </screen>
   </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
-->