mirror of
https://github.com/sigmasternchen/php-doc-en
synced 2025-03-31 00:08:56 +00:00
56 lines
1.6 KiB
XML
56 lines
1.6 KiB
XML
|
<?xml version="1.0" encoding="iso-8859-1"?>
|
||
|
|
<!-- splitted from ./en/functions/dba.xml, last change in rev 1.2 -->
|
||
|
|
<refentry id="function.dba-firstkey">
|
||
|
|
<refnamediv>
|
||
|
|
<refname>dba_firstkey</refname>
|
||
|
|
<refpurpose>Fetch first key</refpurpose>
|
||
|
|
</refnamediv>
|
||
|
|
<refsect1>
|
||
|
|
<title>Description</title>
|
||
|
|
<methodsynopsis>
|
||
|
|
<type>string</type><methodname>dba_firstkey</methodname>
|
||
|
|
<methodparam><type>int</type><parameter>handle</parameter></methodparam>
|
||
|
|
</methodsynopsis>
|
||
|
|
<para>
|
||
|
|
<function>dba_firstkey</function> returns the first key of the
|
||
|
|
database specified by <parameter>handle</parameter> and resets
|
||
|
|
the internal key pointer. This permits a linear search through
|
||
|
|
the whole database.
|
||
|
|
</para>
|
||
|
|
<para>
|
||
|
|
<parameter>Handle</parameter> is a database handle returned by
|
||
|
|
<function>dba_open</function>.
|
||
|
|
</para>
|
||
|
|
<para>
|
||
|
|
<function>dba_firstkey</function> returns the key or &false;
|
||
|
|
depending on whether it succeeds or fails, respectively.
|
||
|
|
</para>
|
||
|
|
<para>
|
||
|
|
See also:
|
||
|
|
<function>dba_nextkey</function>
|
||
|
|
and example 2 in the <link linkend="ref.dba">DBA overview</link>
|
||
|
|
</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:"../../../../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
|
||
|
|
-->
|