mirror of
https://github.com/php/doc-ru.git
synced 2026-04-24 15:58:39 +02:00
Sergey Panteleev
135 lines
4.9 KiB
XML
135 lines
4.9 KiB
XML
<?xml version="1.0" encoding="utf-8"?>
|
|
<!-- EN-Revision: 70528fcff5b182ed42bcdee3acf0bf304896a518 Maintainer: tmn Status: ready -->
|
|
<!-- Reviewed: no -->
|
|
|
|
<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>Перемещение на заданную позицию в потоке</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>
|
|
Этот метод вызывается в процессе выполнения <function>fseek</function>.
|
|
</para>
|
|
<para>
|
|
Позицию чтения/записи в потоке необходимо обновлять в соответствии с
|
|
аргументами <parameter>offset</parameter> и <parameter>whence</parameter>.
|
|
</para>
|
|
</refsect1>
|
|
|
|
<refsect1 role="parameters">
|
|
&reftitle.parameters;
|
|
<para>
|
|
<variablelist>
|
|
<varlistentry>
|
|
<term><parameter>offset</parameter></term>
|
|
<listitem>
|
|
<para>
|
|
Смещение в потоке, на которое требуется переместиться.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><parameter>whence</parameter></term>
|
|
<listitem>
|
|
<para>
|
|
Возможные значения:
|
|
<simplelist>
|
|
<member>
|
|
<constant>SEEK_SET</constant> - Переместиться на позицию
|
|
<parameter>offset</parameter> байт от начала файла.
|
|
</member>
|
|
<member>
|
|
<constant>SEEK_CUR</constant> - Переместиться на
|
|
<parameter>offset</parameter> байт относительно текущей позиции.
|
|
</member>
|
|
<member>
|
|
<constant>SEEK_END</constant> - Переместиться на позицию
|
|
<parameter>offset</parameter> байт от конца файла.
|
|
</member>
|
|
</simplelist>
|
|
</para>
|
|
<note>
|
|
<simpara>
|
|
Текущая реализация никогда не устанавливает для <parameter>whence</parameter>
|
|
значение <constant>SEEK_CUR</constant>; вместо этого такие поиски внутренне преобразуются
|
|
в поиски <constant>SEEK_SET</constant>.
|
|
</simpara>
|
|
</note>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</para>
|
|
</refsect1>
|
|
|
|
<refsect1 role="returnvalues">
|
|
&reftitle.returnvalues;
|
|
<para>
|
|
Возвращает &true;, если позиция обновлена, &false; в остальных случаях.
|
|
</para>
|
|
</refsect1>
|
|
|
|
<refsect1 role="notes"><!-- {{{ -->
|
|
&reftitle.notes;
|
|
<note>
|
|
<para>
|
|
Если не реализован, в качестве возвращаемого значения принимается &false;.
|
|
</para>
|
|
</note>
|
|
<note>
|
|
<para>
|
|
В случае успешного выполнения
|
|
<methodname>streamWrapper::stream_tell</methodname> будет вызвана сразу
|
|
после того, как <methodname>streamWrapper::stream_seek</methodname> отработает.
|
|
Если выполнение <methodname>streamWrapper::stream_tell</methodname> завершится
|
|
неудачей, то в вызывающую функцию будет возвращено значение &false;
|
|
</para>
|
|
</note>
|
|
<note>
|
|
<para>
|
|
Не все операции перемещения в потоке приведут к вызову этой функции. В PHP
|
|
по умолчанию включена буферизация потоков (смотрите также
|
|
<function>stream_set_read_buffer</function>), поэтому перемещение
|
|
в потоке может означать лишь перемещение указателя в буфере.
|
|
</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
|
|
-->
|