mirror of
https://github.com/sigmasternchen/php-doc-en
synced 2025-03-27 14:28:56 +00:00
70528fcff5
git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@350536 c90b9560-bf6c-de11-be94-00142212c4b1
149 lines
4 KiB
XML
149 lines
4 KiB
XML
<?xml version="1.0" encoding="utf-8"?>
|
|
<!-- $Revision$ -->
|
|
|
|
<refentry xml:id="streamwrapper.stream-seek" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
|
|
<refnamediv>
|
|
<refname>streamWrapper::stream_seek</refname>
|
|
<refpurpose>Seeks to specific location in a stream</refpurpose>
|
|
</refnamediv>
|
|
|
|
<refsect1 role="description">
|
|
&reftitle.description;
|
|
<methodsynopsis>
|
|
<modifier>public</modifier> <type>bool</type><methodname>streamWrapper::stream_seek</methodname>
|
|
<methodparam><type>int</type><parameter>offset</parameter></methodparam>
|
|
<methodparam><type>int</type><parameter>whence</parameter> <initializer>SEEK_SET</initializer></methodparam>
|
|
</methodsynopsis>
|
|
<para>
|
|
This method is called in response to <function>fseek</function>.
|
|
</para>
|
|
<para>
|
|
The read/write position of the stream should be updated according to the
|
|
<parameter>offset</parameter> and <parameter>whence</parameter>.
|
|
</para>
|
|
</refsect1>
|
|
|
|
<refsect1 role="parameters">
|
|
&reftitle.parameters;
|
|
<para>
|
|
<variablelist>
|
|
<varlistentry>
|
|
<term><parameter>offset</parameter></term>
|
|
<listitem>
|
|
<para>
|
|
The stream offset to seek to.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><parameter>whence</parameter></term>
|
|
<listitem>
|
|
<para>
|
|
Possible values:
|
|
<simplelist>
|
|
<member><constant>SEEK_SET</constant> - Set position equal to <parameter>offset</parameter> bytes.</member>
|
|
<member><constant>SEEK_CUR</constant> - Set position to current location plus <parameter>offset</parameter>.</member>
|
|
<member><constant>SEEK_END</constant> - Set position to end-of-file plus <parameter>offset</parameter>.</member>
|
|
</simplelist>
|
|
</para>
|
|
<note>
|
|
<simpara>
|
|
The current implementation never sets <parameter>whence</parameter> to
|
|
<constant>SEEK_CUR</constant>; instead such seeks are internally converted
|
|
to <constant>SEEK_SET</constant> seeks.
|
|
</simpara>
|
|
</note>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</para>
|
|
</refsect1>
|
|
|
|
<refsect1 role="returnvalues">
|
|
&reftitle.returnvalues;
|
|
<para>
|
|
Return &true; if the position was updated, &false; otherwise.
|
|
</para>
|
|
</refsect1>
|
|
|
|
<!--
|
|
<refsect1 role="examples">
|
|
&reftitle.examples;
|
|
<para>
|
|
<example>
|
|
<title><function>streamWrapper::stream_seek</function> example</title>
|
|
<programlisting role="php">
|
|
<![CDATA[
|
|
<?php
|
|
/* ... */
|
|
?>
|
|
]]>
|
|
</programlisting>
|
|
&example.outputs.similar;
|
|
<screen>
|
|
<![CDATA[
|
|
...
|
|
]]>
|
|
</screen>
|
|
</example>
|
|
</para>
|
|
</refsect1>
|
|
-->
|
|
|
|
<refsect1 role="notes"><!-- {{{ -->
|
|
&reftitle.notes;
|
|
<note>
|
|
<para>
|
|
If not implemented, &false; is assumed as the return value.
|
|
</para>
|
|
</note>
|
|
<note>
|
|
<para>
|
|
Upon success,
|
|
<methodname>streamWrapper::stream_tell</methodname> is called directly after
|
|
calling <methodname>streamWrapper::stream_seek</methodname>. If
|
|
<methodname>streamWrapper::stream_tell</methodname> fails, the return
|
|
value to the caller function will be set to &false;
|
|
</para>
|
|
</note>
|
|
<note>
|
|
<para>
|
|
Not all seeks operations on the stream will result in this function being
|
|
called. PHP streams have read buffering enabled by default (see also
|
|
<function>stream_set_read_buffer</function>) and seeking may be done by
|
|
merely moving the buffer pointer.
|
|
</para>
|
|
</note>
|
|
</refsect1><!-- }}} -->
|
|
|
|
<refsect1 role="seealso">
|
|
&reftitle.seealso;
|
|
<para>
|
|
<simplelist>
|
|
<member><function>fseek</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
|
|
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
|
|
-->
|