<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.2 $ -->
  <refentry id="function.maxdb-stmt-affected-rows">
   <refnamediv>
    <refname>maxdb_stmt_affected_rows</refname>
    <refname>maxdb_stmt->affected_rows</refname>
    <refpurpose>Returns the total number of rows changed, deleted, or
    inserted by the last executed statement
    </refpurpose>
   </refnamediv>
   <refsect1>
    <title>Description</title>
    <para>Procedural style :</para>
    <methodsynopsis>
     <type>mixed</type><methodname>maxdb_stmt_affected_rows</methodname>
     <methodparam><type>resource</type><parameter>stmt</parameter></methodparam>
    </methodsynopsis>
    <para>Object oriented style (property):</para>
    <classsynopsis>
     <ooclass><classname>stmt</classname></ooclass>
     <fieldsynopsis><type>mixed</type><varname>affected_rows</varname></fieldsynopsis>
    </classsynopsis>
    <para>
     <function>maxdb_stmt_affected_rows</function> returns the number of rows affected
     by INSERT, UPDATE, or DELETE query. If the last query was invalid or the
     number of rows can not determined, this function will return -1.
    </para>
   </refsect1>
   <refsect1>
    <title>Return Values</title>
    <para>
      An integer greater than zero indicates the number of rows affected or retrieved. 
      Zero indicates that no records where updated for an UPDATE/DELETE statement, no
      rows matched the WHERE clause in the query or that no query has yet been executed.
      -1 indicates that the query has returned an error or the number of rows can not determined.
    </para>
   </refsect1>
   <refsect1>
    <title>See also</title>
    <para>
     <function>maxdb_stmt_num_rows</function>,
     <function>maxdb_prepare</function>
    </para>
   </refsect1>
   <refsect1>
    <title>Example</title>
    <example>
     <title>Object oriented style</title>
     <programlisting role="php">
<![CDATA[
<?php
$maxdb = new maxdb("localhost", "MONA", "RED", "DEMODB");

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

/* create temp table */
$maxdb->query("CREATE TABLE temp.mycity LIKE hotel.city");

$query = "INSERT INTO temp.mycity SELECT * FROM hotel.city WHERE state LIKE ?";

/* prepare statement */
if ($stmt = $maxdb->prepare($query)) {

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

   printf("rows inserted: %d\n", $stmt->affected_rows);

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

/* close connection */
$maxdb->close();
?>
]]>
    </programlisting>
    </example>
    <example>
     <title>Procedural style</title>
     <programlisting role="php">
<![CDATA[
<?php
$link = maxdb_connect("localhost", "MONA", "RED", "DEMODB");

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

/* create temp table */
maxdb_query($link, "CREATE TABLE temp.mycity LIKE hotel.city");

$query = "INSERT INTO temp.mycity SELECT * FROM hotel.city WHERE state LIKE ?";

/* prepare statement */
if ($stmt = maxdb_prepare($link, $query)) {

   /* Bind variable for placeholder */
   $code = 'N%';
   maxdb_stmt_bind_param($stmt, "s", $code);
   
   /* execute statement */
   maxdb_stmt_execute($stmt);

   printf("rows inserted: %d\n", maxdb_stmt_affected_rows($stmt));

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

/* close connection */
maxdb_close($link);
?>
]]>
     </programlisting>
    </example>
    <para>
     The above examples would produce the following output:
    </para>
    <screen>
<![CDATA[
rows inserted: 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
-->