php-doc-en/reference/sqlite/functions/sqlite-seek.xml
Kenneth Schwartz ab8f44f73b switch to new structure
git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@180267 c90b9560-bf6c-de11-be94-00142212c4b1
2005-02-21 00:31:07 +00:00

96 lines
2.6 KiB
XML

<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.10 $ -->
<refentry id="function.sqlite-seek">
<refnamediv>
<refname>sqlite_seek</refname>
<refname>SQLiteResult->seek</refname>
<refpurpose>Seek to a particular row number of a buffered result set</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type>bool</type><methodname>sqlite_seek</methodname>
<methodparam><type>resource</type><parameter>result</parameter></methodparam>
<methodparam><type>int</type><parameter>rownum</parameter></methodparam>
</methodsynopsis>
<para>Object oriented style (method):</para>
<classsynopsis>
<ooclass><classname>SQLiteResult</classname></ooclass>
<methodsynopsis>
<type>bool</type><methodname>seek</methodname>
<methodparam><type>int</type><parameter>rownum</parameter></methodparam>
</methodsynopsis>
</classsynopsis>
<para>
<function>sqlite_seek</function> seeks to the row given by the parameter
<parameter>rownum</parameter>.
</para>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<para>
<variablelist>
<varlistentry>
<term><parameter>result</parameter></term>
<listitem>
<para>
The SQLite result resource. This parameter is not required when using
the object-oriented method.
</para>
&sqlite.no-unbuffered;
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>rownum</parameter></term>
<listitem>
<para>
The ordinal row number to seek to. The row number is zero-based (0 is
the first row).
</para>
&sqlite.no-unbuffered;
</listitem>
</varlistentry>
</variablelist>
</para>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
Returns &false; if the row does not exist, &true; otherwise.
</para>
</refsect1>
<refsect1 role="seealso">
&reftitle.seealso;
<para>
<simplelist>
<member><function>sqlite_next</function></member>
<member><function>sqlite_current</function></member>
<member><function>sqlite_rewind</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
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
-->