Document sqlite_fetch_string as an alias of sqlite_fetch_single, and add an example.

git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@134268 c90b9560-bf6c-de11-be94-00142212c4b1
This commit is contained in:
Philip Olson 2003-07-06 14:57:45 +00:00
parent 3afa487ec9
commit e8334068ca
2 changed files with 72 additions and 18 deletions

View file

@ -0,0 +1,69 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.1 $ -->
<refentry id="function.sqlite-fetch-single">
<refnamediv>
<refname>sqlite_fetch_single</refname>
<refpurpose>Fetches the first column of a result set as a string.</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<methodsynopsis>
<type>string</type><methodname>sqlite_fetch_single</methodname>
<methodparam><type>resource</type><parameter>result</parameter></methodparam>
<methodparam choice="opt"><type>int</type><parameter>result_type</parameter></methodparam>
<methodparam choice="opt"><type>bool</type><parameter>decode_binary</parameter></methodparam>
</methodsynopsis>
<para>
<function>sqlite_fetch_single</function> is identical to
<function>sqlite_fetch_array</function> except that it returns the value
of the first column of the rowset.
</para>
<para>
This is the most optimial way to retrieve data when you are only
interested in the values from a single column of data.
</para>
<para>
<example>
<title>A <function>sqlite_fetch_single</function> example</title>
<programlisting role="php">
<![CDATA[
<?php
if ($db = sqlite_open('mysqlitedb', 0666, $sqliteerror)) {
$res = sqlite_query($db, "SELECT id FROM sometable WHERE id = 42");
if (sqlite_num_rows($res) > 0) {
echo sqlite_fetch_single($res); // 42
}
sqlite_close($db);
}
?>
]]>
</programlisting>
</example>
</para>
<para>
See also <function>sqlite_fetch_array</function>.
</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
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
-->

View file

@ -1,29 +1,14 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.3 $ -->
<!-- $Revision: 1.4 $ -->
<refentry id="function.sqlite-fetch-string">
<refnamediv>
<refname>sqlite_fetch_string</refname>
<refpurpose>Fetches the first column of a result set as a string.</refpurpose>
<refpurpose>Alias of <function>sqlite_fetch_single</function></refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<methodsynopsis>
<type>string</type><methodname>sqlite_fetch_string</methodname>
<methodparam><type>resource</type><parameter>result</parameter></methodparam>
<methodparam choice="opt"><type>int</type><parameter>result_type</parameter></methodparam>
<methodparam choice="opt"><type>bool</type><parameter>decode_binary</parameter></methodparam>
</methodsynopsis>
<para>
<function>sqlite_fetch_string</function> is identical to
<function>sqlite_fetch_array</function> except that it returns the value
of the first column of the rowset.
</para>
<para>
This is the most optimial way to retrieve data when you are only
interested in the values from a single column of data.
</para>
<para>
See also <function>sqlite_fetch_array</function>.
This function is an alias of <function>sqlite_fetch_single</function>.
</para>
</refsect1>
</refentry>