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
|
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision: 297028 $ -->
<!-- Author: Wez Furlong <wez@thebrainroom.com>
Please contact me before making any major amendments to the
content of this section. Splitting/Merging are fine if they are
required for php-doc restructuring purposes - just drop me a line
if you make a change (so I can update my local copy).
-->
<sect2 xml:id="internals2.ze1.streams.file-api" xmlns="http://docbook.org/ns/docbook">
<title>Streams File API Reference</title>
<refentry xml:id="internals2.ze1.streams.php-stream-fopen-from-file">
<refnamediv>
<refname>php_stream_fopen_from_file</refname>
<refpurpose>Convert an ANSI FILE* into a stream</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<methodsynopsis>
<type>php_stream *</type><methodname>php_stream_fopen_from_file</methodname>
<methodparam><type>FILE *</type><parameter>file</parameter></methodparam>
<methodparam><type>char *</type><parameter>mode</parameter></methodparam>
</methodsynopsis>
<para>
<function>php_stream_fopen_from_file</function> returns a stream based on the
<parameter>file</parameter>. <parameter>mode</parameter> must be the same
as the mode used to open <parameter>file</parameter>, otherwise strange errors
may occur when trying to write when the mode of the stream is different from the mode
on the file.
</para>
</refsect1>
</refentry>
<refentry xml:id="internals2.ze1.streams.php-stream-fopen-tmpfile">
<refnamediv>
<refname>php_stream_fopen_tmpfile</refname>
<refpurpose>Open a FILE* with tmpfile() and convert into a stream</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<methodsynopsis>
<type>php_stream *</type><methodname>php_stream_fopen_tmpfile</methodname>
<methodparam><type>void</type><parameter></parameter></methodparam>
</methodsynopsis>
<para>
<function>php_stream_fopen_tmpfile</function> returns a stream based on a
temporary file opened with a mode of "w+b". The temporary file will be deleted
automatically when the stream is closed or the process terminates.
</para>
</refsect1>
</refentry>
<refentry xml:id="internals2.ze1.streams.php-stream-fopen-temporary-file">
<refnamediv>
<refname>php_stream_fopen_temporary_file</refname>
<refpurpose>Generate a temporary file name and open a stream on it</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<methodsynopsis>
<type>php_stream *</type><methodname>php_stream_fopen_temporary_file</methodname>
<methodparam><type>const char *</type><parameter>dir</parameter></methodparam>
<methodparam><type>const char *</type><parameter>pfx</parameter></methodparam>
<methodparam><type>char **</type><parameter>opened</parameter></methodparam>
</methodsynopsis>
<para>
<function>php_stream_fopen_temporary_file</function> generates a temporary file name
in the directory specified by <parameter>dir</parameter> and with a prefix of <parameter>pfx</parameter>.
The generated file name is returns in the <parameter>opened</parameter> parameter, which you
are responsible for cleaning up using <function>efree</function>.
A stream is opened on that generated filename in "w+b" mode.
The file is NOT automatically deleted; you are responsible for unlinking or moving the file when you have
finished with it.
</para>
</refsect1>
</refentry>
</sect2>
<!-- 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
-->
|
