php-doc-en/reference/msql/functions/msql-result.xml
Torben Wilson af4410a7e1 Normalized the sgml-default-dtd-file local-variable line for those
still using this, after discussion on the phpdoc list.
From now on, manual.ced will need to be found at ~/.phpdoc/manual.ced.



git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@288721 c90b9560-bf6c-de11-be94-00142212c4b1
2009-09-25 07:04:39 +00:00

94 lines
2.8 KiB
XML

<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision$ -->
<refentry xml:id="function.msql-result" xmlns="http://docbook.org/ns/docbook">
<refnamediv>
<refname>msql_result</refname>
<refpurpose>Get result data</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type>string</type><methodname>msql_result</methodname>
<methodparam><type>resource</type><parameter>result</parameter></methodparam>
<methodparam><type>int</type><parameter>row</parameter></methodparam>
<methodparam choice="opt"><type>mixed</type><parameter>field</parameter></methodparam>
</methodsynopsis>
<para>
<function>msql_result</function> returns the contents of one cell from a
mSQL result 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 are often
much quicker than <function>msql_result</function>.
</para>
<para>
Recommended high-performance alternatives:
<function>msql_fetch_row</function>,
<function>msql_fetch_array</function>, and
<function>msql_fetch_object</function>.
</para>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<para>
<variablelist>
&msql.result.description;
<varlistentry>
<term><parameter>row</parameter></term>
<listitem>
<para>
The row offset.
</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 (tablename.fieldname.). 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 field offset is much quicker than specifying a
fieldname or tablename.fieldname.
</para>
</note>
</listitem>
</varlistentry>
</variablelist>
</para>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
Returns the contents of the cell at the row and offset in the
specified mSQL result set.
</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
-->