php-doc-en/reference/fbsql/functions/fbsql-result.xml
Mehdi Achour 40243d10c9 ref.fbsql: switch to new style
and document 7 functions


git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@227795 c90b9560-bf6c-de11-be94-00142212c4b1
2007-01-22 00:22:11 +00:00

108 lines
3 KiB
XML

<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.6 $ -->
<refentry id="function.fbsql-result">
<refnamediv>
<refname>fbsql_result</refname>
<refpurpose>Get result data</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type>mixed</type><methodname>fbsql_result</methodname>
<methodparam><type>resource</type><parameter>result</parameter></methodparam>
<methodparam choice="opt"><type>int</type><parameter>row</parameter></methodparam>
<methodparam choice="opt"><type>mixed</type><parameter>field</parameter></methodparam>
</methodsynopsis>
<para>
Returns the contents of one cell from a FrontBase
<parameter>result</parameter> set.
</para>
<para>
When working on large result sets, you should consider using one
of the functions that fetch an entire row (specified below). As
these functions return the contents of multiple cells in one
function call, they're MUCH quicker than <function>fbsql_result</function>.
</para>
<para>
Calls to <function>fbsql_result</function> should not be mixed
with calls to other functions that deal with the result set.
</para>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<para>
<variablelist>
&fbsql.result.description;
<varlistentry>
<term><parameter>row</parameter></term>
<listitem>
<para>
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>field</parameter></term>
<listitem>
<para>
Can be the field's offset, or the field's name, or the field's table
dot field's name (tabledname.fieldname).
</para>
<para>
If the column name has been aliased ('select foo as bar from...'), use
the alias instead of the column name.
</para>
<note>
<para>
Specifying a numeric offset for the field argument is much quicker
than specifying a fieldname or tablename.fieldname argument.
</para>
</note>
</listitem>
</varlistentry>
</variablelist>
</para>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
</para>
</refsect1>
<refsect1 role="seealso">
&reftitle.seealso;
<para>
Recommended high-performance alternatives:
<simplelist>
<member><function>fbsql_fetch_row</function></member>
<member><function>fbsql_fetch_array</function></member>
<member><function>fbsql_fetch_assoc</function></member>
<member><function>fbsql_fetch_object</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:"../../../../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
-->