-
Notifications
You must be signed in to change notification settings - Fork 50
/
stream-seek.xml
143 lines (134 loc) · 3.95 KB
/
stream-seek.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
132
133
134
135
136
137
138
139
140
141
142
143
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<!-- EN-Revision: 2dfaaa96a927cae6a7e0eaa1cf0ff57c56845169 Maintainer: serros Status: ready -->
<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>Busca la ubicación específica en un flujo</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>
Este método es llamado en respuesta a <function>fseek</function>.
</para>
<para>
La posición de lectura/escritura del flujo debería ser actualizada según
<parameter>offset</parameter> y <parameter>whence</parameter>.
</para>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<para>
<variablelist>
<varlistentry>
<term><parameter>offset</parameter></term>
<listitem>
<para>
El flujo de desplazamiento a buscar.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>whence</parameter></term>
<listitem>
<para>
Valores posibles:
<simplelist>
<member><constant>SEEK_SET</constant> - Establece la posición igual a <parameter>offset</parameter> bytes.</member>
<member><constant>SEEK_CUR</constant> - Establece la posición de la ubicación actual más <parameter>offset</parameter>.</member>
<member><constant>SEEK_END</constant> - Establece la posición al final del archivo más <parameter>offset</parameter>.</member>
</simplelist>
</para>
</listitem>
</varlistentry>
</variablelist>
</para>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
Devuelve &true; si la posición se ha actualizado, si no &false;.
</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>
Si no está implementado, se asume que el valor devuelto es &false;
</para>
</note>
<note>
<para>
Si se tuvo éxito,
<methodname>streamWrapper::stream_tell</methodname> se llama directamente, después
de llamar a <methodname>streamWrapper::stream_seek</methodname>. Si
<methodname>streamWrapper::stream_tell</methodname> falla, el valor devuelto
a la función de llamada se establece en &false;
</para>
</note>
<note>
<para>
No todas las operaciones de búsqueda de el flujo conllevan a la llamada de
esta función. Los flujos de PHP tienen buffer para la lectura activado por defecto (véase también
<function>stream_set_read_buffer</function>) y la búsqueda se puede realizar con sólo mover el
puntero del buffer.
</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
-->