mirror of
https://github.com/sigmasternchen/php-doc-en
synced 2025-03-25 13:28:56 +00:00
8190ee59a5
git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@150059 c90b9560-bf6c-de11-be94-00142212c4b1
82 lines
2.9 KiB
XML
82 lines
2.9 KiB
XML
<?xml version="1.0" encoding="iso-8859-1"?>
|
|
<!-- $Revision: 1.6 $ -->
|
|
<refentry id="function.mysqli-use-result">
|
|
<refnamediv>
|
|
<refname>mysqli_use_result</refname>
|
|
<refname>mysqli->use_result</refname>
|
|
<refpurpose>Initiate a result set retrieval</refpurpose>
|
|
</refnamediv>
|
|
<refsect1>
|
|
<title>Description</title>
|
|
<para>Procedural style:</para>
|
|
<methodsynopsis>
|
|
<type>mixed</type><methodname>mysqli_use_result</methodname>
|
|
<methodparam><type>object</type><parameter>link</parameter></methodparam>
|
|
</methodsynopsis>
|
|
<para>Object oriented style (method):</para>
|
|
<classsynopsis>
|
|
<ooclass><classname>mysqli</classname></ooclass>
|
|
<methodsynopsis>
|
|
<type>mixed</type>
|
|
<methodname>use_result</methodname>
|
|
<methodparam><type>void</type><parameter></parameter></methodparam>
|
|
</methodsynopsis>
|
|
</classsynopsis>
|
|
<para>
|
|
<function>mysqli_use_result</function> is used to initiate the retrieval
|
|
of a result set from the last query executed using the
|
|
<function>mysqli_real_query</function> function on the database connection
|
|
specified by the <parameter>link</parameter> parameter. Either this or the
|
|
<function>mysqli_store_result</function> function must be called before the
|
|
results of a query can be retrieved, and one or the other must be called
|
|
to prevent the next query on that database connection from failing.
|
|
</para>
|
|
<note>
|
|
<para>
|
|
The <function>mysqli_use_result</function> function does not transfer
|
|
the entire result set from the database and hence cannot be used functions
|
|
such as <function>mysqli_data_seek</function> to move to a particular
|
|
row within the set. To use this functionality, the result set must be
|
|
stored using <function>mysqli_store_result</function>. One should not
|
|
use <function>mysqli_use_result</function> if a lot of processing on
|
|
the client side is performed, since this will tie up the server and
|
|
prevent other threads from updating any tables from which the data is
|
|
being fetched.
|
|
</para>
|
|
</note>
|
|
</refsect1>
|
|
<refsect1>
|
|
<title>Return values</title>
|
|
<para>
|
|
Returns an unbuffered result object or &false; if an error occured.
|
|
</para>
|
|
</refsect1>
|
|
<refsect1>
|
|
<title>See also</title>
|
|
<para>
|
|
<function>mysqli_real_query</function>,
|
|
<function>mysqli_store_result</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
|
|
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
|
|
-->
|