<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.3 $ -->
  <refentry id="function.maxdb-affected-rows">
 <refnamediv>
  <refname>maxdb_affected_rows</refname>
  <refname>maxdb->affected_rows</refname>
  <refpurpose>Gets the number of affected rows in a previous MaxDB operation</refpurpose>
 </refnamediv>
 <refsect1>
  <title>Description</title>
  <para>Procedural style:</para>
  <methodsynopsis>
   <type>int</type><methodname>maxdb_affected_rows</methodname>
   <methodparam><type>resource</type><parameter>link</parameter></methodparam>
  </methodsynopsis>
  <para>Object oriented style (property):</para>
  <classsynopsis>
   <ooclass><classname>maxdb</classname></ooclass>
   <fieldsynopsis><type>int</type><varname>affected_rows</varname></fieldsynopsis>
  </classsynopsis>
  <para>
   <function>maxdb_affected_rows</function> returns the number of rows affected by the last 
   INSERT, UPDATE, or DELETE query associated with the provided <parameter>link</parameter>
   parameter. If this number cannot be determined, this function will return -1.
  </para>
  <note>
   <para>
    For SELECT statements <function>maxdb_affected_rows</function> works like
    <function>maxdb_num_rows</function>.
   </para>
  </note>
  <para>
   The <function>maxdb_affected_rows</function> function only works with queries which modify
   a table. In order to return the number of rows from a SELECT query, use the
   <function>maxdb_num_rows</function> function instead.
  </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 statement, no rows matched 
   the WHERE clause in the query or that no query has yet been executed. 
   -1 indicates that the number of rows affected can not be determined.
  </para>
 </refsect1>
 <refsect1>
  <title>See also</title>
  <para>
   <function>maxdb_num_rows</function>,
   <function>maxdb_info</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();
}

maxdb_report (MAXDB_REPORT_OFF);
$maxdb->query("DROP TABLE mycustomer");
maxdb_report (MAXDB_REPORT_ERROR);

/* Insert rows */
$maxdb->query("CREATE TABLE mycustomer AS SELECT * from hotel.customer");
printf("Affected rows (INSERT): %d\n", $maxdb->affected_rows);

$maxdb->query("ALTER TABLE mycustomer ADD Status int default 0");

/* update rows */
$maxdb->query("UPDATE mycustomer SET Status=1 WHERE cno > 50");
printf("Affected rows (UPDATE): %d\n", $maxdb->affected_rows);

/* delete rows */
$maxdb->query("DELETE FROM mycustomer WHERE cno < 50");
printf("Affected rows (DELETE): %d\n", $maxdb->affected_rows);

/* select all rows */
$result = $maxdb->query("SELECT title FROM mycustomer");
printf("Affected rows (SELECT): %d\n", $maxdb->affected_rows);

$result->close();

/* Delete table Language */
$maxdb->query("DROP TABLE mycustomer");

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

if (!$link) {
   printf("Can't connect to localhost. Error: %s\n", maxdb_connect_error());
   exit();
}

maxdb_report (MAXDB_REPORT_OFF);
maxdb_query($link,"DROP TABLE mycustomer");
maxdb_report (MAXDB_REPORT_ERROR);

/* Insert rows */
maxdb_query($link, "CREATE TABLE mycustomer AS SELECT * from hotel.customer");
printf("Affected rows (INSERT): %d\n", maxdb_affected_rows($link));

maxdb_query($link, "ALTER TABLE mycustomer ADD Status int default 0");

/* update rows */
maxdb_query($link, "UPDATE mycustomer SET Status=1 WHERE cno > 50");
printf("Affected rows (UPDATE): %d\n", maxdb_affected_rows($link));

/* delete rows */
maxdb_query($link, "DELETE FROM mycustomer WHERE cno < 50");
printf("Affected rows (DELETE): %d\n", maxdb_affected_rows($link));

/* select all rows */
$result = maxdb_query($link, "SELECT title FROM mycustomer");
printf("Affected rows (SELECT): %d\n", maxdb_affected_rows($link));

maxdb_free_result($result);

/* Delete table Language */
maxdb_query($link, "DROP TABLE mycustomer");

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