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
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
|
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.10 $ -->
<refentry xml:id="function.dio-open" xmlns="http://docbook.org/ns/docbook">
<refnamediv>
<refname>dio_open</refname>
<refpurpose>
Opens a new filename with specified permissions of flags and
creation permissions of mode
</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type>resource</type><methodname>dio_open</methodname>
<methodparam><type>string</type><parameter>filename</parameter></methodparam>
<methodparam><type>int</type><parameter>flags</parameter></methodparam>
<methodparam choice="opt"><type>int</type><parameter>mode</parameter></methodparam>
</methodsynopsis>
<para>
<function>dio_open</function> opens a file and returns a new file
descriptor for it.
</para>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<para>
<variablelist>
<varlistentry>
<term><parameter>filename</parameter></term>
<listitem>
<para>
The opened file.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>flags</parameter></term>
<listitem>
<para>
The <parameter>flags</parameter> parameter can also include any
combination of the following flags:
<itemizedlist>
<listitem>
<para>
<constant>O_CREAT</constant> - creates the file, if it doesn't
already exist.
</para>
</listitem>
<listitem>
<para>
<constant>O_EXCL</constant> - if both, <constant>O_CREAT</constant>
and <constant>O_EXCL</constant> are set, <function>dio_open</function>
fails, if the file already exists.
</para>
</listitem>
<listitem>
<para>
<constant>O_TRUNC</constant> - if the file exists, and its opened
for write access, the file will be truncated to zero length.
</para>
</listitem>
<listitem>
<para>
<constant>O_APPEND</constant> - write operations write data at the
end of the file.
</para>
</listitem>
<listitem>
<para>
<constant>O_NONBLOCK</constant> - sets non blocking mode.
</para>
</listitem>
</itemizedlist>
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>mode</parameter></term>
<listitem>
<para>
If <parameter>flags</parameter> is <constant>O_CREAT</constant>,
<parameter>mode</parameter> will set the mode of the file
(creation permissions).
<itemizedlist>
<listitem>
<para>
<constant>O_RDONLY</constant> - opens the file for read access.
</para>
</listitem>
<listitem>
<para>
<constant>O_WRONLY</constant> - opens the file for write access.
</para>
</listitem>
<listitem>
<para>
<constant>O_RDWR</constant> - opens the file for both reading and
writing.
</para>
</listitem>
</itemizedlist>
</para>
</listitem>
</varlistentry>
</variablelist>
</para>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
A file descriptor or &false; on error.
</para>
</refsect1>
<refsect1 role="examples">
&reftitle.examples;
<example>
<title>Opening a file descriptor</title>
<programlisting role="php">
<![CDATA[
<?php
$fd = dio_open('/dev/ttyS0', O_RDWR | O_NOCTTY | O_NONBLOCK);
dio_close($fd);
?>
]]>
</programlisting>
</example>
</refsect1>
<refsect1 role="seealso">
&reftitle.seealso;
<para>
<simplelist>
<member><function>dio_close</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
-->
|
