php-doc-en/reference/ingres-ii/functions/ingres-num-rows.xml
Daniel Egeberg 96c9d88bad Converted to utf-8
git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@297028 c90b9560-bf6c-de11-be94-00142212c4b1
2010-03-28 22:10:10 +00:00

99 lines
2.8 KiB
XML

<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<refentry xml:id="function.ingres-num-rows" xmlns="http://docbook.org/ns/docbook">
<refnamediv>
<refname>ingres_num_rows</refname>
<refpurpose>Get the number of rows affected or returned by a query</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type>int</type><methodname>ingres_num_rows</methodname>
<methodparam><type>resource</type><parameter>result</parameter></methodparam>
</methodsynopsis>
<para>
This function primarily is meant to get the number of rows
modified in the database. However, it can be used to retrieve the number of
rows to fetch for a SELECT statement.
</para>
<note>
<para>
If <link
linkend="ini.ingres.scrollable">scrollable cursors</link> are disabled and
this function is called before
using <function>ingres_fetch_array</function>,
<function>ingres_fetch_object</function>, or
<function>ingres_fetch_row</function>, the server will delete
the result's data and the script will be unable to get them.
</para>
<para>
Instead, you should retrieve the result's data using one of
these fetch functions in a loop until it returns &false;,
indicating that no more results are available.
</para>
</note>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<para>
<variablelist>
<varlistentry>
<term><parameter>result</parameter></term>
<listitem>
<para>
The result identifier for a query
</para>
</listitem>
</varlistentry>
</variablelist>
</para>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
For delete, insert, or update queries,
<function>ingres_num_rows</function> returns the number of rows
affected by the query. For other queries,
<function>ingres_num_rows</function> returns the number of rows
in the query's result.
</para>
</refsect1>
<refsect1 role="seealso">
&reftitle.seealso;
<para>
<simplelist>
<member><function>ingres_query</function></member>
<member><function>ingres_fetch_array</function></member>
<member><function>ingres_fetch_assoc</function></member>
<member><function>ingres_fetch_object</function></member>
<member><function>ingres_fetch_row</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
-->