mirror of
https://github.com/sigmasternchen/php-doc-en
synced 2025-03-28 14:58:55 +00:00
5b9fc29465
git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@78496 c90b9560-bf6c-de11-be94-00142212c4b1
121 lines
3.6 KiB
XML
121 lines
3.6 KiB
XML
<?xml version="1.0" encoding="iso-8859-1"?>
|
|
<!-- $Revision: 1.2 $ -->
|
|
<!-- splitted from ./en/functions/sesam.xml, last change in rev 1.1 -->
|
|
<refentry id="function.sesam-seek-row">
|
|
<refnamediv>
|
|
<refname>sesam_seek_row</refname>
|
|
<refpurpose>
|
|
Set scrollable cursor mode for subsequent fetches
|
|
</refpurpose>
|
|
</refnamediv>
|
|
<refsect1>
|
|
<title>Description</title>
|
|
<methodsynopsis>
|
|
<type>bool</type><methodname>sesam_seek_row</methodname>
|
|
<methodparam><type>string</type><parameter>result_id</parameter></methodparam>
|
|
<methodparam><type>int</type><parameter>whence</parameter></methodparam>
|
|
<methodparam choice="opt"><type>int</type><parameter>offset</parameter></methodparam>
|
|
</methodsynopsis>
|
|
<para>
|
|
<parameter>result_id</parameter> is a valid result id (select
|
|
type queries only, and only if a "scrollable" cursor was
|
|
requested when calling <function>sesam_query</function>).
|
|
</para>
|
|
<para>
|
|
<parameter>whence</parameter> sets the global default value for
|
|
the scrolling type, it specifies the scroll type to use in
|
|
subsequent fetch operations on "scrollable" cursors, which can be
|
|
set to the following predefined constants:
|
|
<table>
|
|
<title>Valid values for <parameter>"whence"</parameter> parameter</title>
|
|
<tgroup cols="3">
|
|
<thead>
|
|
<row>
|
|
<entry>Value</entry>
|
|
<entry>Constant</entry>
|
|
<entry>Meaning</entry>
|
|
</row>
|
|
</thead>
|
|
<tbody>
|
|
<row>
|
|
<entry>0</entry>
|
|
<entry><literal>SESAM_SEEK_NEXT</literal></entry>
|
|
<entry>read sequentially
|
|
</entry>
|
|
</row>
|
|
<row>
|
|
<entry>1</entry>
|
|
<entry><literal>SESAM_SEEK_PRIOR</literal></entry>
|
|
<entry>read sequentially backwards
|
|
</entry>
|
|
</row>
|
|
<row>
|
|
<entry>2</entry>
|
|
<entry><literal>SESAM_SEEK_FIRST</literal></entry>
|
|
<entry>
|
|
fetch first row (after fetch, the default is set to
|
|
<literal>SESAM_SEEK_NEXT</literal>)
|
|
</entry>
|
|
</row>
|
|
<row>
|
|
<entry>3</entry>
|
|
<entry><literal>SESAM_SEEK_LAST</literal></entry>
|
|
<entry>
|
|
fetch last row (after fetch, the default is set to
|
|
<literal>SESAM_SEEK_PRIOR</literal>)
|
|
</entry>
|
|
</row>
|
|
<row>
|
|
<entry>4</entry>
|
|
<entry><literal>SESAM_SEEK_ABSOLUTE</literal></entry>
|
|
<entry>
|
|
fetch absolute row number given as
|
|
<parameter>offset</parameter> (Zero-based. After fetch, the
|
|
default is set to <literal>SESAM_SEEK_ABSOLUTE</literal>,
|
|
and the offset value is auto-incremented)
|
|
</entry>
|
|
</row>
|
|
<row>
|
|
<entry>5</entry>
|
|
<entry><literal>SESAM_SEEK_RELATIVE</literal></entry>
|
|
<entry>
|
|
fetch relative to current scroll position, where
|
|
<parameter>offset</parameter> can be a positive or negative
|
|
offset value (this also sets the default "offset" value for
|
|
subsequent fetches).
|
|
</entry>
|
|
</row>
|
|
</tbody>
|
|
</tgroup>
|
|
</table>
|
|
</para>
|
|
<para>
|
|
<parameter>offset</parameter> is an optional
|
|
parameter which is only evaluated (and required) if
|
|
<parameter>whence</parameter> is either
|
|
<literal>SESAM_SEEK_RELATIVE</literal> or
|
|
<literal>SESAM_SEEK_ABSOLUTE</literal>.
|
|
</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
|
|
-->
|