php-doc-en/reference/mysqli/functions/mysqli-stmt-num-rows.xml

<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.7 $ -->
  <refentry id="function.mysqli-stmt-num-rows">
   <refnamediv>
    <refname>mysqli_stmt_num_rows</refname>
    <refname>stmt->num_rows</refname>
    <refpurpose>Return the number of rows in statements result set</refpurpose>
   </refnamediv>
   <refsect1>
    <title>Description</title>
    <para>Procedural style :</para>
    <methodsynopsis>
     <type>mixed</type><methodname>mysqli_stmt_num_rows</methodname>
     <methodparam><type>mysqli_stmt</type><parameter>stmt</parameter></methodparam>
    </methodsynopsis>
    <para>Object oriented style (property):</para>
    <classsynopsis>
     <ooclass><classname>mysqli_stmt</classname></ooclass>
     <fieldsynopsis><type>int</type><varname>num_rows</varname></fieldsynopsis>
    </classsynopsis>
    <para>
     Returns the number of rows in the result set.
     The use of <function>mysqli_stmt_num_rows</function>
     depends on whether or not you used 
     <function>mysqli_stmt_store_result</function> to buffer the entire result
     set in the statement handle.
    </para>
    <para>
     If you use <function>mysqli_stmt_store_result</function>, 
     <function>mysqli_stmt_num_rows</function> may be called immediately. 
    </para>
   </refsect1>
   <refsect1>
    &reftitle.returnvalues;
    <para>
     An integer representing the number of rows in result set.
    </para> 
   </refsect1>
   <refsect1>
    &reftitle.seealso;
    <para>
     <function>mysqli_stmt_affected_rows</function>,
     <function>mysqli_prepare</function>&listendand;
     <function>mysqli_stmt_store_result</function>.
    </para>
   </refsect1>
   <refsect1>
    &reftitle.examples;
    <example>
     <title>Object oriented style</title>
     <programlisting role="php">
<![CDATA[
<?php
/* Open a connection */
$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 Name LIMIT 20";
if ($stmt = $mysqli->prepare($query)) {

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

    /* store result */
    $stmt->store_result();

    printf("Number of rows: %d.\n", $stmt->num_rows);

    /* close statement */
    $stmt->close();
}

/* close connection */
$mysqli->close();
?>
]]>
    </programlisting>
    </example>
    <example>
     <title>Procedural style</title>
     <programlisting role="php">
<![CDATA[
<?php
/* Open a connection */
$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 Name LIMIT 20";
if ($stmt = mysqli_prepare($link, $query)) {

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

    /* store result */
    mysqli_stmt_store_result($stmt);

    printf("Number of rows: %d.\n", mysqli_stmt_num_rows($stmt));

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

/* close connection */
mysqli_close($link);
?>
]]>
     </programlisting>
    </example>
    &example.outputs;
    <screen>
<![CDATA[
Number of rows: 20.
]]>
    </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
-->