mirror of
https://github.com/sigmasternchen/php-doc-en
synced 2025-03-26 13:58:55 +00:00
8ef6cf9b7c
git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@324735 c90b9560-bf6c-de11-be94-00142212c4b1
100 lines
2.4 KiB
XML
100 lines
2.4 KiB
XML
<?xml version="1.0" encoding="utf-8"?>
|
|
<!-- $Revision$ -->
|
|
<refentry xml:id="function.dbase-numrecords" xmlns="http://docbook.org/ns/docbook">
|
|
<refnamediv>
|
|
<refname>dbase_numrecords</refname>
|
|
<refpurpose>Gets the number of records in a database</refpurpose>
|
|
</refnamediv>
|
|
<refsect1 role="description">
|
|
&reftitle.description;
|
|
<methodsynopsis>
|
|
<type>int</type><methodname>dbase_numrecords</methodname>
|
|
<methodparam><type>int</type><parameter>dbase_identifier</parameter></methodparam>
|
|
</methodsynopsis>
|
|
<para>
|
|
Gets the number of records (rows) in the specified database.
|
|
</para>
|
|
<note>
|
|
<para>
|
|
Record numbers are between 1 and <literal>dbase_numrecords($db)</literal>,
|
|
while field numbers are between 0 and <literal>dbase_numfields($db)-1</literal>.
|
|
</para>
|
|
</note>
|
|
</refsect1>
|
|
<refsect1 role="parameters">
|
|
&reftitle.parameters;
|
|
<para>
|
|
<variablelist>
|
|
<varlistentry>
|
|
<term><parameter>dbase_identifier</parameter></term>
|
|
<listitem>
|
|
<para>
|
|
The database link identifier, returned by <function>dbase_open</function>
|
|
or <function>dbase_create</function>.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</para>
|
|
</refsect1>
|
|
<refsect1 role="returnvalues">
|
|
&reftitle.returnvalues;
|
|
<para>
|
|
The number of records in the database, or &false; if an error occurs.
|
|
</para>
|
|
</refsect1>
|
|
<refsect1 role="examples">
|
|
&reftitle.examples;
|
|
<para>
|
|
<example>
|
|
<title>Looping over all the records of the database</title>
|
|
<programlisting role="php">
|
|
<![CDATA[
|
|
<?php
|
|
|
|
// open in read-only mode
|
|
$db = dbase_open('/tmp/test.dbf', 0);
|
|
|
|
if ($db) {
|
|
$record_numbers = dbase_numrecords($db);
|
|
for ($i = 1; $i <= $record_numbers; $i++) {
|
|
// do something here, for each record
|
|
}
|
|
}
|
|
|
|
?>
|
|
]]>
|
|
</programlisting>
|
|
</example>
|
|
</para>
|
|
</refsect1>
|
|
<refsect1 role="seealso">
|
|
&reftitle.seealso;
|
|
<para>
|
|
<simplelist>
|
|
<member><function>dbase_numfields</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
|
|
-->
|