php-doc-en/reference/mysqli/functions/mysqli-stmt-bind-result.xml

<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.10 $ -->
<refentry id="function.mysqli-stmt-bind-result">
 <refnamediv>
  <refname>mysqli_stmt_bind_result</refname>
  <refname>stmt->bind_result()</refname>
  <refpurpose>Binds variables to a prepared statement for result storage</refpurpose>
 </refnamediv>

 <refsect1 role="description">
  &reftitle.description;
  <para>Procedural style:</para>
  <methodsynopsis>
   <type>bool</type><methodname>mysqli_stmt_bind_result</methodname>
   <methodparam><type>mysqli_stmt</type><parameter>stmt</parameter></methodparam>
   <methodparam><type>mixed</type><parameter role="reference">var1</parameter></methodparam>
   <methodparam choice="opt"><type>mixed</type><parameter role="reference">...</parameter></methodparam>
  </methodsynopsis>
  <para>Object oriented style (method):</para>
   <classsynopsis>
   <ooclass><classname>mysqli_stmt</classname></ooclass>
   <methodsynopsis>
    <type>bool</type><methodname>bind_result</methodname>
    <methodparam><type>mixed</type><parameter role="reference">var1</parameter></methodparam>
    <methodparam choice="opt"><type>mixed</type><parameter role="reference">...</parameter></methodparam>
   </methodsynopsis>
  </classsynopsis>
  <para>
   Binds columns in the result set to variables.
  </para>
  <para>
   When <function>mysqli_stmt_fetch</function> is called to fetch data, the
   MySQL client/server protocol places the data for the bound columns into
   the specified variables <parameter>var1, ...</parameter>.
  </para>
  <note>
   <para>
    Note that all columns must be bound after 
    <function>mysqli_stmt_execute</function> and prior to calling
    <function>mysqli_stmt_fetch</function>.
    Depending on column types bound variables can silently change to the
    corresponding PHP type.
   </para>
   <para>
    A column can be bound or rebound at any time, even after a result set has
    been partially retrieved. The new binding takes effect the next time 
    <function>mysqli_stmt_fetch</function> is called.
   </para>
  </note>
 </refsect1>

 <refsect1 role="parameters">
  &reftitle.parameters;
  <para>
   <variablelist>
    &mysqli.stmt.description;
    <varlistentry>
     <term><parameter>var1</parameter></term>
     <listitem>
      <para>
       The variable to be bound.
      </para>
     </listitem>
    </varlistentry>
   </variablelist>
  </para>
 </refsect1>

 <refsect1 role="returnvalues">
  &reftitle.returnvalues;
  <para>
   &return.success;
  </para>
 </refsect1>

 <refsect1 role="examples">
  &reftitle.examples;
  <example>
   <title>Object oriented style</title>
   <programlisting role="php">
<![CDATA[
<?php
$mysqli = new mysqli("localhost", "my_user", "my_password", "world");

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

/* prepare statement */
if ($stmt = $mysqli->prepare("SELECT Code, Name FROM Country ORDER BY Name LIMIT 5")) {
    $stmt->execute();

    /* bind variables to prepared statement */
    $stmt->bind_result($col1, $col2);

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

    /* 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 (!$link) {
    printf("Connect failed: %s\n", mysqli_connect_error());
    exit();
}

/* prepare statement */
if ($stmt = mysqli_prepare($link, "SELECT Code, Name FROM Country ORDER BY Name LIMIT 5")) {
    mysqli_stmt_execute($stmt);

    /* bind variables to prepared statement */
    mysqli_stmt_bind_result($stmt, $col1, $col2);

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

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

/* close connection */
mysqli_close($link);
?>
]]>
   </programlisting>
  </example>
  &example.outputs;
  <screen>
<![CDATA[
AFG Afghanistan
ALB Albania
DZA Algeria
ASM American Samoa
AND Andorra
]]>
  </screen>
 </refsect1>

 <refsect1 role="seealso">
  &reftitle.seealso;
  <para>
   <simplelist>
    <member><function>mysqli_stmt_bind_param</function></member>
    <member><function>mysqli_stmt_execute</function></member>
    <member><function>mysqli_stmt_fetch</function></member>
    <member><function>mysqli_prepare</function></member>
    <member><function>mysqli_stmt_prepare</function></member>
    <member><function>mysqli_stmt_init</function></member>
    <member><function>mysqli_stmt_errno</function></member>
    <member><function>mysqli_stmt_error</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
-->