affected-rows.xml

<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<refentry xml:id="mysqli-stmt.affected-rows" xmlns="http://docbook.org/ns/docbook">
 <refnamediv>
  <refname>mysqli_stmt::$affected_rows</refname>
  <refname>mysqli_stmt_affected_rows</refname>
  <refpurpose>Returns the total number of rows changed, deleted, inserted, or
  matched by the last statement executed
  </refpurpose>
 </refnamediv>

 <refsect1 role="description">
  &reftitle.description;
  <para>&style.oop;</para>
  <fieldsynopsis><type class="union"><type>int</type><type>string</type></type><varname linkend="mysqli-stmt.affected-rows">mysqli_stmt-&gt;affected_rows</varname></fieldsynopsis>
  <para>&style.procedural;</para>
  <methodsynopsis>
   <type class="union"><type>int</type><type>string</type></type><methodname>mysqli_stmt_affected_rows</methodname>
   <methodparam><type>mysqli_stmt</type><parameter>statement</parameter></methodparam>
  </methodsynopsis>
  <para>
   Returns the number of rows affected by <literal>INSERT</literal>,
   <literal>UPDATE</literal>, or <literal>DELETE</literal> query. 
   Works like <function>mysqli_stmt_num_rows</function> for
   <literal>SELECT</literal> statements.
  </para>
 </refsect1>

 <refsect1 role="parameters">
  &reftitle.parameters;
  <para>
   <variablelist>
    &mysqli.stmt.description;
   </variablelist>
  </para>
 </refsect1>

 <refsect1 role="returnvalues">
  &reftitle.returnvalues;
  <para>
   An integer greater than zero indicates the number of rows affected or
   retrieved. Zero indicates that no records were updated for an 
   <literal>UPDATE</literal> statement, no rows matched the
   <literal>WHERE</literal> clause in the query or that no query has yet been
   executed. <literal>-1</literal> indicates that the query returned an error or
   that, for a <literal>SELECT</literal> query,
   <function>mysqli_stmt_affected_rows</function> was called prior to calling
   <function>mysqli_stmt_store_result</function>.
  </para>
  <note>
   <para>
    If the number of affected rows is greater than maximum PHP int value, the
    number of affected rows will be returned as a string value.
   </para>
  </note>
 </refsect1>

 <refsect1 role="examples">
 &reftitle.examples;
  <example>
   <title><methodname>mysqli_stmt_affected_rows</methodname> example</title>
   <para>&style.oop;</para>
   <programlisting role="php">
<![CDATA[
<?php

mysqli_report(MYSQLI_REPORT_ERROR | MYSQLI_REPORT_STRICT);
$mysqli = new mysqli("localhost", "my_user", "my_password", "world");

/* create temp table */
$mysqli->query("CREATE TEMPORARY TABLE myCountry LIKE Country");

$query = "INSERT INTO myCountry SELECT * FROM Country WHERE Code LIKE ?";

/* prepare statement */
$stmt = $mysqli->prepare($query);

/* Bind variable for placeholder */
$code = 'A%';
$stmt->bind_param("s", $code);

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

printf("Rows inserted: %d\n", $stmt->affected_rows);
]]>
   </programlisting>
   <para>&style.procedural;</para>
   <programlisting role="php">
<![CDATA[
<?php

mysqli_report(MYSQLI_REPORT_ERROR | MYSQLI_REPORT_STRICT);
$link = mysqli_connect("localhost", "my_user", "my_password", "world");

/* create temp table */
mysqli_query($link, "CREATE TEMPORARY TABLE myCountry LIKE Country");

$query = "INSERT INTO myCountry SELECT * FROM Country WHERE Code LIKE ?";

/* prepare statement */
$stmt = mysqli_prepare($link, $query);

/* Bind variable for placeholder */
$code = 'A%';
mysqli_stmt_bind_param($stmt, "s", $code);

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

printf("Rows inserted: %d\n", mysqli_stmt_affected_rows($stmt));
]]>
   </programlisting>
   &examples.outputs;
   <screen>
<![CDATA[
Rows inserted: 17
]]>
   </screen>
  </example>
 </refsect1>

 <refsect1 role="seealso">
  &reftitle.seealso;
  <para>
   <simplelist>
    <member><function>mysqli_stmt_num_rows</function></member>
    <member><function>mysqli_stmt_store_result</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:"~/.phpdoc/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
-->