-
Notifications
You must be signed in to change notification settings - Fork 70
/
fseek.xml
131 lines (121 loc) · 4.65 KB
/
fseek.xml
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
<?xml version="1.0" encoding="utf-8"?>
<!-- EN-Revision: d51166ca16fda8e766849505b84f9306ef443f71 Maintainer: tmn Status: ready -->
<!-- Reviewed: no -->
<refentry xml:id="splfileobject.fseek" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
<refnamediv>
<refname>SplFileObject::fseek</refname>
<refpurpose>Перемещает положение файлового указателя</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis role="SplFileObject">
<modifier>public</modifier> <type>int</type><methodname>SplFileObject::fseek</methodname>
<methodparam><type>int</type><parameter>offset</parameter></methodparam>
<methodparam choice="opt"><type>int</type><parameter>whence</parameter><initializer><constant>SEEK_SET</constant></initializer></methodparam>
</methodsynopsis>
<para>
Метод перемещает положение указателя в файле на позицию,
которую получает путём добавления смещения <parameter>offset</parameter>
к положению, которое указали в параметре <parameter>whence</parameter>.
Положение измеряется в байтах от начала файла.
</para>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<para>
<variablelist>
<varlistentry>
<term><parameter>offset</parameter></term>
<listitem>
<para>
Смещение. Отрицательные значения указывают
для перемещения назад по файлу, что полезно, когда флаг SEEK_END указывают
как значение параметра <parameter>whence</parameter>.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>whence</parameter></term>
<listitem>
<para>
Параметр <parameter>whence</parameter> принимает следующие значения:
<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>
<para>
Метод будет работать в режиме <constant>SEEK_SET</constant>,
если параметр <parameter>whence</parameter> не указали.
</para>
</listitem>
</varlistentry>
</variablelist>
</para>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
Метод возвращает 0 при успешном перемещении, иначе -1. Обратите внимание,
что метод не считает ошибкой перемещение за пределы файла.
</para>
</refsect1>
<refsect1 role="examples">
&reftitle.examples;
<para>
<example>
<title>Пример использования метода <methodname>SplFileObject::fseek</methodname></title>
<programlisting role="php">
<![CDATA[
<?php
$file = new SplFileObject("somefile.txt");
// Считываем первую строку
$data = $file->fgets();
// Перемещаемся в начало файла
// То же, что и вызов метода $file->rewind();
$file->fseek(0);
?>
]]>
</programlisting>
</example>
</para>
</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
-->