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

<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.2 $ -->
  <refentry id="function.mysqli-stmt-fetch">
   <refnamediv>
    <refname>mysqli_stmt_fetch</refname>
    <refname>stmt->fetch</refname>
    <refpurpose>
     Fetch results from a prepared statement into the bound variables
    </refpurpose>
   </refnamediv>
   <refsect1>
    <title>Description</title>
    <para>Procedural style:</para>
    <methodsynopsis>
     <type>mixed</type><methodname>mysqli_stmt_fetch</methodname>
     <methodparam><type>object</type><parameter>stmt</parameter></methodparam>
    </methodsynopsis>
    <para>Object oriented style (method):</para>
    <classsynopsis>
     <ooclass><classname>stmt</classname></ooclass>
     <methodsynopsis>
      <type>mixed</type>
      <methodname>fetch</methodname>
      <void />
     </methodsynopsis>
    </classsynopsis>    
    <para>
     <function>mysqli_stmt_fetch</function> returns row data using the variables bound by <function>mysqli_stmt_bind_result</function>.
    </para>
    <note>
     <para>
      Note that all columns must be bound by the application before calling <function>mysqli_stmt_fetch</function>. 
     </para>
    </note>
   </refsect1>
   <refsect1>
    <title>Return values</title>
    <table>
     <title>Return values</title>
     <tgroup cols='2'>
      <thead>
       <row>
        <entry>Value</entry>
        <entry>Description</entry>
       </row>
      </thead>
      <tbody>
       <row>
        <entry>&true;</entry>
        <entry>Success. Data has been fetched</entry>
       </row>
       <row>
        <entry>&false;</entry>
        <entry>Error occured</entry>
       </row>
       <row>
        <entry><literal>&null;</literal></entry>
        <entry>No more rows/data exists</entry>
       </row>
      </tbody>
     </tgroup>
    </table>
   </refsect1>
   <refsect1>
    <title>See also</title>
    <para>
     <function>mysqli_prepare</function>,
     <function>mysqli_stmt_errno</function>,
     <function>mysqli_stmt_error</function>,
     <function>mysqli_stmt_bind_result</function>
    </para>
   </refsect1>
   <refsect1>
    <title>Example</title>
    <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, CountryCode FROM City ORDER by ID DESC LIMIT 150,5";

if ($stmt = $mysqli->prepare($query)) {

    /* execute statement */
    $stmt->execute();

    /* bind result variables */
    $stmt->bind_result($name, $code);

    /* fetch values */
    while ($stmt->fetch()) {
        printf ("%s (%s)\n", $name, $code);
    }

    /* close statement */
    $stmt->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, CountryCode FROM City ORDER by ID DESC LIMIT 150,5";

if ($stmt = mysqli_prepare($link, $query)) {

    /* execute statement */
    mysqli_stmt_execute($stmt);

    /* bind result variables */
    mysqli_stmt_bind_result($stmt, $name, $code);

    /* fetch values */
    while (mysqli_stmt_fetch($stmt)) {
        printf ("%s (%s)\n", $name, $code);
    }

    /* close statement */
    mysqli_stmt_close($stmt);
}

/* close connection */
mysqli_close($link);
?>
]]>
     </programlisting>
    </example>
    <para>
     The above examples would produce the following output:
    </para>
    <screen>
<![CDATA[
Rockford (USA)
Tallahassee (USA)
Salinas (USA)
Santa Clarita (USA)
Springfield (USA)
]]>
    </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
-->