php-doc-en/reference/oci8/ocilob/seek.xml
Máté Kocsis b9e6268918
Rename OCI-Lob and OCI-Collection
Closes GH-1323.
2022-01-14 14:26:19 +01:00

122 lines
3.2 KiB
XML

<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<refentry xml:id="ocilob.seek" xmlns="http://docbook.org/ns/docbook">
<refnamediv>
<refname>OCILob::seek</refname>
<refpurpose>Sets the internal pointer of the large object</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis role="oop">
<modifier>public</modifier> <type>bool</type><methodname>OCILob::seek</methodname>
<methodparam><type>int</type><parameter>offset</parameter></methodparam>
<methodparam choice="opt"><type>int</type><parameter>whence</parameter><initializer><constant>OCI_SEEK_SET</constant></initializer></methodparam>
</methodsynopsis>
<para>
Sets the internal pointer of the large object.
</para>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<para>
<variablelist>
<varlistentry>
<term><parameter>offset</parameter></term>
<listitem>
<para>
Indicates the amount of bytes, on which internal pointer should be
moved from the position, pointed by <parameter>whence</parameter>.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>whence</parameter></term>
<listitem>
<para>
May be one of:
<simplelist>
<member>
<constant>OCI_SEEK_SET</constant> - sets the position equal to
<parameter>offset</parameter>
</member>
<member>
<constant>OCI_SEEK_CUR</constant> - adds <parameter>offset</parameter>
bytes to the current position
</member>
<member>
<constant>OCI_SEEK_END</constant> - adds <parameter>offset</parameter>
bytes to the end of large object (use negative value to move to a position
before the end of large object)
</member>
</simplelist>
</para>
</listitem>
</varlistentry>
</variablelist>
</para>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
&return.success;
</para>
</refsect1>
<refsect1 role="changelog">
&reftitle.changelog;
<informaltable>
<tgroup cols="2">
<thead>
<row>
<entry>&Version;</entry>
<entry>&Description;</entry>
</row>
</thead>
<tbody>
<row>
<entry>8.0.0, PECL OCI8 3.0.0</entry>
<entry>
The <classname>OCI-Lob</classname> class was renamed to
<classname>OCILob</classname> to align with PHP naming standards.
</entry>
</row>
</tbody>
</tgroup>
</informaltable>
</refsect1>
<refsect1 role="seealso">
&reftitle.seealso;
<para>
<simplelist>
<member><xref linkend="ocilob.rewind"/></member>
<member><xref linkend="ocilob.tell"/></member>
<member><xref linkend="ocilob.eof"/></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:"~/.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
-->