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
|
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.4 $ -->
<!-- splitted from ./en/functions/zip.xml, last change in rev 1.11 -->
<refentry id="function.zip-entry-open">
<refnamediv>
<refname>zip_entry_open</refname>
<refpurpose>Open a directory entry for reading</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type>bool</type><methodname>zip_entry_open</methodname>
<methodparam><type>resource</type><parameter>zip</parameter></methodparam>
<methodparam><type>resource</type><parameter>zip_entry</parameter></methodparam>
<methodparam choice="opt"><type>string</type><parameter>mode</parameter></methodparam>
</methodsynopsis>
<para>
Opens a directory entry in a zip file for reading.
</para>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<para>
<variablelist>
<varlistentry>
<term><parameter>zip</parameter></term>
<listitem>
<para>
A valid resource handle returned by <function>zip_open</function>.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>zip_entry</parameter></term>
<listitem>
<para>
A directory entry returned by <function>zip_read</function>.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>mode</parameter></term>
<listitem>
<para>
Any of the modes specified in the documentation of
<function>fopen</function>.
</para>
<note>
<para>
Currently, <parameter>mode</parameter> is ignored and is always
<literal>"rb"</literal>. This is due to the fact that zip support
in PHP is read only access.
</para>
</note>
</listitem>
</varlistentry>
</variablelist>
</para>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
&return.success;
</para>
<note>
<para>
Unlike <function>fopen</function> and other similar functions,
the return value of <function>zip_entry_open</function> only
indicates the result of the operation and is not needed for
reading or closing the directory entry.
</para>
</note>
</refsect1>
<refsect1 role="seealso">
&reftitle.seealso;
<para>
<simplelist>
<member><function>zip_entry_close</function></member>
<member><function>zip_entry_read</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:"../../../../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
-->
|
