-
Notifications
You must be signed in to change notification settings - Fork 149
/
gzseek.xml
126 lines (126 loc) · 3.88 KB
/
gzseek.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
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<!-- EN-Revision: 02ba67b51f2bde571b6ce07026e935f4e81019af Maintainer: yannick Status: ready -->
<!-- Reviewed: yes -->
<refentry xml:id="function.gzseek" xmlns="http://docbook.org/ns/docbook">
<refnamediv>
<refname>gzseek</refname>
<refpurpose>Déplace le pointeur de lecture</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type>int</type><methodname>gzseek</methodname>
<methodparam><type>resource</type><parameter>stream</parameter></methodparam>
<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>
<function>gzseek</function> place le pointeur de lecture du fichier
<parameter>zp</parameter> à la position <parameter>offset</parameter>,
comptée en octets depuis le début du fichier. C'est l'équivalent
de la fonction <literal>gzseek(zp, offset, SEEK_SET)</literal>,
du langage C.
</para>
<para>
Si le fichier est ouvert en lecture, cette fonction est alors émulée,
et se révèle extrêmement lente. Si le fichier est ouvert en écriture,
seuls les déplacements vers l'avant sont supportés : <function>gzseek</function>
compresse alors une série de zéros jusqu'à la nouvelle position.
</para>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<para>
<variablelist>
<varlistentry>
<term><parameter>stream</parameter></term>
<listitem>
<para>
Le pointeur de fichier gz. Il doit être valide et doit pointer vers
un fichier ouvert avec succès grâce à la fonction <function>gzopen</function>.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>offset</parameter></term>
<listitem>
<para>
La position désirée.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>whence</parameter></term>
<listitem>
<para>
Les valeurs de <parameter>whence</parameter> sont :
<simplelist>
<member><constant>SEEK_SET</constant> : ramène la position à l'<parameter>offset</parameter>.</member>
<member><constant>SEEK_CUR</constant> : ramène la position à la position actuelle plus <parameter>offset</parameter>.</member>
</simplelist>
</para>
<para>
Si <parameter>whence</parameter> n'est pas spécifié, il vaut par défaut
<constant>SEEK_SET</constant>.
</para>
</listitem>
</varlistentry>
</variablelist>
</para>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
0 en cas de réussite, -1 sinon. Notez que placer le pointeur au delà de la fin
du fichier n'est pas considéré comme une erreur.
</para>
</refsect1>
<refsect1 role="examples">
&reftitle.examples;
<para>
<example>
<title>Exemple avec <function>gzseek</function></title>
<programlisting role="php">
<![CDATA[
<?php
$gz = gzopen('somefile.gz', 'r');
gzseek($gz,2);
echo gzgetc($gz);
gzclose($gz);
?>
]]>
</programlisting>
</example>
</para>
</refsect1>
<refsect1 role="seealso">
&reftitle.seealso;
<para>
<simplelist>
<member><function>gztell</function></member>
<member><function>gzrewind</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
-->