php-doc-en/reference/dba/functions/dba-fetch.xml
2003-11-13 09:40:08 +00:00

88 lines
2.9 KiB
XML

<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.6 $ -->
<!-- splitted from ./en/functions/dba.xml, last change in rev 1.2 -->
<refentry id="function.dba-fetch">
<refnamediv>
<refname>dba_fetch</refname>
<refpurpose>Fetch data specified by key</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<methodsynopsis>
<type>string</type><methodname>dba_fetch</methodname>
<methodparam><type>string</type><parameter>key</parameter></methodparam>
<methodparam><type>resource</type><parameter>handle</parameter></methodparam>
</methodsynopsis>
<methodsynopsis>
<type>string</type><methodname>dba_fetch</methodname>
<methodparam><type>string</type><parameter>key</parameter></methodparam>
<methodparam><type>int</type><parameter>skip</parameter></methodparam>
<methodparam><type>resource</type><parameter>handle</parameter></methodparam>
</methodsynopsis>
<para>
<function>dba_fetch</function> fetches the data specified by
<parameter>key</parameter> from the database specified with
<parameter>handle</parameter>.
</para>
<para>
<parameter>Key</parameter> is the key the data is specified by.
</para>
<para>
<parameter>Skip</parameter> is the number of key-value pairs to
ignore when using cdb databases. This value is ignored for all other
databases which do not support multiple keys with the same name.
</para>
<para>
<parameter>Handle</parameter> is a database handle returned by
<function>dba_open</function>.
</para>
<para>
<function>dba_fetch</function> returns the associated string or &false;, if
the key/data pair is found or not found, respectively.
</para>
<para>
See also: <function>dba_exists</function>,
<function>dba_delete</function>, <function>dba_insert</function>,
<function>dba_replace</function> and <function>dba_key_split</function>.
</para>
<para>
<note>
<simpara>
The skip parameter is available since PHP 4.3 to support cdb's
capability of multiple keys having the same name.
</simpara>
</note>
</para>
<para>
<note>
<simpara>
When working with inifiles this function accepts arrays as keys
where index 0 is the group and index 1 is the value name. See:
<function>dba_key_split</function>.
</simpara>
</note>
</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
-->