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
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
|
<?xml version="1.0" encoding="UTF-8"?>
<!--
* Scilab ( http://www.scilab.org/ ) - This file is part of Scilab
* Copyright (C) XXXX-2008 - INRIA
*
* This file must be used under the terms of the CeCILL.
* This source file is licensed as described in the file COPYING, which
* you should have received as part of this distribution. The terms
* are also available at
* http://www.cecill.info/licences/Licence_CeCILL_V2.1-en.txt
*
-->
<refentry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xmlns:svg="http://www.w3.org/2000/svg" xmlns:ns4="http://www.w3.org/1999/xhtml" xmlns:mml="http://www.w3.org/1998/Math/MathML" xmlns:db="http://docbook.org/ns/docbook" xmlns:scilab="http://www.scilab.org" xml:id="file" xml:lang="en">
<refnamediv>
<refname>file</refname>
<refpurpose>file management</refpurpose>
</refnamediv>
<refsynopsisdiv>
<title>Calling Sequence</title>
<synopsis>[unit [,err]]=file("open", file-name [,status] [,access [,recl]] [,format])
file("close", unit)
file("rewind", unit)
file("backspace", unit)
file("last", unit)
[units [,typ [,nams [,mod [,swap]]]]] = file([unit])
</synopsis>
</refsynopsisdiv>
<refsection>
<title>Arguments</title>
<variablelist>
<varlistentry>
<term>file-name</term>
<listitem>
<para>string, file name of the file to be opened</para>
</listitem>
</varlistentry>
<varlistentry>
<term>status</term>
<listitem>
<para>string, The status of the file to be opened</para>
<variablelist>
<varlistentry>
<term>"new"</term>
<listitem>
<para>file must not exist new file (default)</para>
</listitem>
</varlistentry>
<varlistentry>
<term>"old"</term>
<listitem>
<para>file must already exists.</para>
</listitem>
</varlistentry>
<varlistentry>
<term>"unknown"</term>
<listitem>
<para>unknown status</para>
</listitem>
</varlistentry>
<varlistentry>
<term>"scratch"</term>
<listitem>
<para>file is to be deleted at end of session</para>
</listitem>
</varlistentry>
</variablelist>
</listitem>
</varlistentry>
<varlistentry>
<term>access</term>
<listitem>
<para>string, The type of access to the file</para>
<variablelist>
<varlistentry>
<term>"sequential"</term>
<listitem>
<para>sequential access (default)</para>
</listitem>
</varlistentry>
<varlistentry>
<term>"direct"</term>
<listitem>
<para>direct access.</para>
</listitem>
</varlistentry>
</variablelist>
</listitem>
</varlistentry>
<varlistentry>
<term>format</term>
<listitem>
<para>string,</para>
<variablelist>
<varlistentry>
<term>"formatted"</term>
<listitem>
<para>for a formatted file (default)</para>
</listitem>
</varlistentry>
<varlistentry>
<term>"unformatted"</term>
<listitem>
<para>binary record.</para>
</listitem>
</varlistentry>
</variablelist>
</listitem>
</varlistentry>
<varlistentry>
<term>recl</term>
<listitem>
<para>integer,is the size of records in bytes when
<literal>access="direct"</literal>
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>unit</term>
<listitem>
<para>integer, logical unit descriptor of the opened file</para>
</listitem>
</varlistentry>
<varlistentry>
<term>units</term>
<listitem>
<para>integer vector, logical unit descriptor of the opened files.
Units 5 and 6 (%io) are reserved by the system for input and output
devices.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>typs</term>
<listitem>
<para>Character string vector, type (C or Fortran) of opened
files.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>nams</term>
<listitem>
<para>Character string vector, pathnames of opened files.</para>
</listitem>
</varlistentry>
<varlistentry>
<term>mod</term>
<listitem>
<para>file opening mode. Formed by three digits abc</para>
<variablelist>
<varlistentry>
<term>Fortran files</term>
<listitem>
<variablelist>
<varlistentry>
<term>a</term>
<listitem>
<para>0 stands for formatted and 1 for unformatted
(binary)
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>b</term>
<listitem>
<para>0 stands for sequential access and 1 for direct
access
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>c</term>
<listitem>
<para>0 stands for "new", 1 for "old", 2 for "scratch"
and 3 for "unknown"
</para>
</listitem>
</varlistentry>
</variablelist>
</listitem>
</varlistentry>
<varlistentry>
<term>C files</term>
<listitem>
<variablelist>
<varlistentry>
<varlistentry>
<term>a</term>
<listitem>
<para>1 stands for "r" (read), 2 stands for "w" (write)
and 3 for "a" (append)
</para>
</listitem>
<varlistentry>
<term>b</term>
<listitem>
<para>is 1 if file has been opened with a "+" (updating)
mode
</para>
</listitem>
</varlistentry>
</varlistentry>
<term>b</term>
<listitem>
<para>is 1 if file has been opened with a "b" (binary)
mode
</para>
</listitem>
</varlistentry>
</variablelist>
</listitem>
</varlistentry>
</variablelist>
</listitem>
</varlistentry>
<varlistentry>
<term>swap</term>
<listitem>
<para>automatic swap switch. swap=1 if automatic swap is on. swap is
always 0 for Fortran files.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>err</term>
<listitem>
<para>integer, error message number (see error), if open fails. If
err is omitted an error message is issued.
</para>
</listitem>
</varlistentry>
</variablelist>
</refsection>
<refsection>
<title>Description</title>
<para>
selects a logical unit <varname>unit</varname> and manages the file
<varname>file-name</varname>.
</para>
<variablelist>
<varlistentry>
<term>[unit [,err]]=file("open", file-name [,status] [,access
[,recl]][,format])
</term>
<listitem>
<para>
allows to open a file with specified
properties and to get the associated unit number <varname>unit</varname>.
This unit number may be used for further actions on this file or as file
descriptor in <function>read</function>, <function>write</function>,
<function>readb</function>,
<function>writb</function>,<function>save</function>, <function>load</function>
function calls.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>
file("close", unit)
</term>
<listitem>
<para>
allows to close the file, or move the current file pointer.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>
file("rewind", unit)
</term>
<listitem>
<para>
puts the pointer at the beginning of file.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>
file("backspace", unit)
</term>
<listitem>
<para>
puts the pointer at the beginning of last record.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>
file("last", unit)
</term>
<listitem>
<para>
puts the pointer after last record.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>
file()
</term>
<listitem>
<para>
returns the logical unit descriptors of
the opened files. So <literal>file("close",file())</literal> closes all
user opened files (C or Fortran type).
</para>
</listitem>
</varlistentry>
</variablelist>
<para>
This function can not open a UTF filename. In this case, please uses
mopen.
</para>
</refsection>
<refsection>
<title>Examples</title>
<programlisting role="example"><![CDATA[
u=file("open",TMPDIR+"/foo","unknown")
for k=1:4
a=rand(1,4)
write(u,a)
end
file("rewind",u)
x=read(u,2,4)
file("close",u)
//
u1=file("open",TMPDIR+"/foo","unknown")
u2=mopen(TMPDIR+"/foo1","wb")
[units,typs,nams]=file()
file("close",u1);
mclose(u2);
]]></programlisting>
</refsection>
<refsection role="see also">
<title>See Also</title>
<simplelist type="inline">
<member>
<link linkend="save">save</link>
</member>
<member>
<link linkend="load">load</link>
</member>
<member>
<link linkend="write">write</link>
</member>
<member>
<link linkend="read">read</link>
</member>
<member>
<link linkend="writb">writb</link>
</member>
<member>
<link linkend="readb">readb</link>
</member>
<member>
<link linkend="uigetfile">uigetfile</link>
</member>
<member>
<link linkend="mopen">mopen</link>
</member>
<member>
<link linkend="mclose">mclose</link>
</member>
</simplelist>
</refsection>
</refentry>
|
