* Bug 16365 fixed: median(m,'r'|'c') was wrong after 5dc990
[scilab.git] / scilab / modules / io / help / ja_JP / file.xml
1 <?xml version="1.0" encoding="UTF-8"?>
2 <!--
3  * Scilab ( http://www.scilab.org/ ) - This file is part of Scilab
4  * Copyright (C) XXXX-2008 - INRIA
5  * Copyright (C) 2012 - 2016 - Scilab Enterprises
6  * Copyright (C) 2018 - Samuel GOUGEON
7  *
8  * This file is hereby licensed under the terms of the GNU GPL v2.0,
9  * pursuant to article 5.3.4 of the CeCILL v.2.1.
10  * This file was originally licensed under the terms of the CeCILL v2.1,
11  * and continues to be available under such terms.
12  * For more information, see the COPYING file which you should have received
13  * along with this program.
14  *
15  -->
16 <refentry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink"
17           xmlns:svg="http://www.w3.org/2000/svg" xmlns:ns4="http://www.w3.org/1999/xhtml"
18           xmlns:mml="http://www.w3.org/1998/Math/MathML" xmlns:db="http://docbook.org/ns/docbook"
19           xmlns:scilab="http://www.scilab.org" xml:id="file" xml:lang="ja">
20     <refnamediv>
21         <refname>file</refname>
22         <refpurpose>ファイル管理</refpurpose>
23     </refnamediv>
24     <refsynopsisdiv>
25         <title>呼び出し手順</title>
26         <synopsis>
27             [unit, err] = file("open", file-name [,status] [,access [,recl]] [,format])
28             file("close", unit)
29             file("rewind", unit)
30             file("backspace", unit)
31             file("last", unit)
32             [units, typ, nams, mod, swap] = file()
33             [units, typ, nams, mod, swap] = file(unit)
34         </synopsis>
35     </refsynopsisdiv>
36     <refsection>
37         <title>パラメータ</title>
38         <variablelist>
39             <varlistentry>
40                 <term>file-name</term>
41                 <listitem>
42                     <para>文字列, オープンするファイルのファイル名</para>
43                     <warning>
44                         この関数は、ASCII以外のUTF文字(アクセント付きなど)を含むパスまたは名前のファイルを開くことはできません.
45                         この場合,mopenを使用してください.
46                     </warning>
47                 </listitem>
48             </varlistentry>
49             <varlistentry>
50                 <term>status</term>
51                 <listitem>
52                     <para>文字列, オープンするファイルのステータス</para>
53                     <variablelist>
54                         <varlistentry>
55                             <term>"new"</term>
56                             <listitem>
57                                 <para>ファイルは存在せず新規ファイル (デフォルト)</para>
58                             </listitem>
59                         </varlistentry>
60                         <varlistentry>
61                             <term>"old"</term>
62                             <listitem>
63                                 <para>ファイルは既存.</para>
64                             </listitem>
65                         </varlistentry>
66                         <varlistentry>
67                             <term>"unknown"</term>
68                             <listitem>
69                                 <para>unknown status</para>
70                             </listitem>
71                         </varlistentry>
72                         <varlistentry>
73                             <term>"scratch"</term>
74                             <listitem>
75                                 <para>ファイルはセッション終了時に削除されます</para>
76                             </listitem>
77                         </varlistentry>
78                     </variablelist>
79                 </listitem>
80             </varlistentry>
81             <varlistentry>
82                 <term>access</term>
83                 <listitem>
84                     <para>文字列, ファイルへのアクセス形式</para>
85                     <variablelist>
86                         <varlistentry>
87                             <term>"sequential"</term>
88                             <listitem>
89                                 <para>連続アクセス (デフォルト)</para>
90                             </listitem>
91                         </varlistentry>
92                         <varlistentry>
93                             <term>"direct"</term>
94                             <listitem>
95                                 <para>直接アクセス.</para>
96                             </listitem>
97                         </varlistentry>
98                     </variablelist>
99                 </listitem>
100             </varlistentry>
101             <varlistentry>
102                 <term>format</term>
103                 <listitem>
104                     <para>文字列,</para>
105                     <variablelist>
106                         <varlistentry>
107                             <term>"formatted"</term>
108                             <listitem>
109                                 <para>フォーマットされたファイル (デフォルト)</para>
110                             </listitem>
111                         </varlistentry>
112                         <varlistentry>
113                             <term>"unformatted"</term>
114                             <listitem>
115                                 <para>バイナリレコード.</para>
116                             </listitem>
117                         </varlistentry>
118                     </variablelist>
119                 </listitem>
120             </varlistentry>
121             <varlistentry>
122                 <term>recl</term>
123                 <listitem>
124                     <para>整数,
125                         <literal>access="direct"</literal>の時,
126                         レコードの大きさ(単位:バイト)
127                     </para>
128                 </listitem>
129             </varlistentry>
130             <varlistentry>
131                 <term>unit</term>
132                 <listitem>
133                     <para>整数, オープンされたファイルの論理ユニット記述子</para>
134                 </listitem>
135             </varlistentry>
136             <varlistentry>
137                 <term>units</term>
138                 <listitem>
139                     <para>整数ベクトル, オープンされたファイルの論理ユニット記述子.
140                         ユニット 5 および 6 (%io) は入出力デバイスの
141                         システムにより保存されます.
142                     </para>
143                 </listitem>
144             </varlistentry>
145             <varlistentry>
146                 <term>typs</term>
147                 <listitem>
148                     <para>文字列ベクトル, オープンするファイルの型
149                         (C または Fortran).
150                     </para>
151                 </listitem>
152             </varlistentry>
153             <varlistentry>
154                 <term>nams</term>
155                 <listitem>
156                     <para>文字列ベクトル, オープンするファイルのパス名.</para>
157                 </listitem>
158             </varlistentry>
159             <varlistentry>
160                 <term>mod</term>
161                 <listitem>
162                     <para>ファイルをオープンするモード. 3桁 abc により構成.
163                     </para>
164                     <table border="0">
165                         <tr valign="top">
166                             <td colspan="2"><emphasis role="bold">Fortranファイル</emphasis></td>
167                         </tr>
168                         <tr valign="top">
169                             <th>a</th>
170                             <td>0 は整形済み, 1 は未整形(バイナリ)を意味します</td>
171                         </tr>
172                         <tr valign="top">
173                             <th>b</th>
174                             <td>0 は連続アクセス, 1 は直接アクセスを意味します</td>
175                         </tr>
176                         <tr valign="top">
177                             <th>c</th>
178                             <td>0 は "new", 1 は "old", 2 は "scratch" および 3 は "unknown"を意味します</td>
179                         </tr>
180                         <tr valign="top">
181                             <td colspan="2"><emphasis role="bold">Cファイル</emphasis></td>
182                         </tr>
183                         <tr valign="top">
184                             <th>a</th>
185                             <td>1は "r" (読み込み)を意味し, 2 は "w" (書き込み) そして 3 は "a" (追加)を意味します</td>
186                         </tr>
187                         <tr valign="top">
188                             <th>b</th>
189                             <td>ファイルが "+" (更新)モードでオープンされている場合に 1</td>
190                         </tr>
191                         <tr valign="top">
192                             <th>c</th>
193                             <td>ファイルが "b" (バイナリ)モードで オープンされている場合に 1</td>
194                         </tr>
195                     </table>
196                 </listitem>
197             </varlistentry>
198             <varlistentry>
199                 <term>swap</term>
200                 <listitem>
201                     <para>
202                         自動スワップの切替スイッチ.
203                         自動スワップがオンの場合に swap=1.
204                         Fortranファイルの場合,swapは常に0となります.
205                     </para>
206                 </listitem>
207             </varlistentry>
208             <varlistentry>
209                 <term>err</term>
210                 <listitem>
211                     <para>整数, オープンに失敗した場合は, エラーメッセージ番号. <varname>err</varname>
212                     が省略された場合,エラーメッセージが発行されます.
213                     </para>
214                     <table>
215                         <tr valign="top"><th>65</th><td>File already used</td></tr>
216                         <tr valign="top"><th>66</th><td>Too many files opened!</td></tr>
217                         <tr valign="top"><th>67</th><td>Unknown file format</td></tr>
218                         <tr valign="top"><th>240</th>
219                                          <td>The file already exists or directory write
220                                              access denied.</td></tr>
221                         <tr valign="top"><th>241</th><td>The file does not exist or read access denied.</td></tr>
222                     </table>
223                 </listitem>
224             </varlistentry>
225             <varlistentry>
226                 <term>action</term>
227                 <listitem>
228                     <para>以下の文字列のどれかとなります:</para>
229                     <variablelist>
230                         <varlistentry>
231                             <term>"close"</term>
232                             <listitem>
233                                 <para>
234                                     <literal>units</literal>で指定された
235                                     論理ユニット記述子により指定されたファイルを閉じます
236                                 </para>
237                             </listitem>
238                         </varlistentry>
239                         <varlistentry>
240                             <term>"rewind"</term>
241                             <listitem>
242                                 <para>ファイルの先頭にポインタを置きます</para>
243                             </listitem>
244                         </varlistentry>
245                         <varlistentry>
246                             <term>"backspace"</term>
247                             <listitem>
248                                 <para>ポインタを最後のレコードの先頭に置きます</para>
249                             </listitem>
250                         </varlistentry>
251                         <varlistentry>
252                             <term>"last"</term>
253                             <listitem>
254                                 <para>
255                                     ポインタを最後のレコードの後に置きます.
256                                 </para>
257                             </listitem>
258                         </varlistentry>
259                     </variablelist>
260                 </listitem>
261             </varlistentry>
262         </variablelist>
263     </refsection>
264     <refsection>
265         <title>説明</title>
266         <para>
267             論理ユニット<literal>unit</literal>を選択し,
268             ファイル<literal>file-name</literal>を管理します.
269         </para>
270         <para>
271             <literal>[unit [,err]]=file('open', file-name [,status] [,access
272                 [,recl]][,format])
273             </literal>
274             により
275             プロパティを指定してファイルをオープンし,
276             ユニット番号<literal>unit</literal>に関連付けることができます.
277             このユニット番号は,この後,このファイルに関する処理や
278             <literal>read</literal>, <literal>write</literal>,
279             <literal>readb</literal>,
280             <literal>writb</literal>,<literal>save</literal>, <literal>load</literal>
281             関数コールにおいてファイル記述子と同様に使用することができます.
282         </para>
283         <para>
284             <literal>file(action,unit)</literal> により,ファイルを閉じたり,
285             カレントのファイルポインタを移動することができます.
286         </para>
287         <para>
288             <literal>file()</literal> は
289             オープンされたファイルの論理ユニット記述子を返します.この場合,
290             <literal>file('close',file() )</literal> は
291             ユーザにオープンされたファイル(CまたはFortran型)を全て閉じます.
292         </para>
293         <para>To test whether a file  #<literal>id</literal> is opened,
294             <literal>file(id)~=[]</literal> may be used.
295         </para>
296     </refsection>
297     <refsection>
298         <title>例</title>
299         <programlisting role="example"><![CDATA[
300 u=file('open',TMPDIR+'/foo','unknown')
301 for k=1:4
302   a=rand(1,4)
303   write(u,a)
304 end
305 file('rewind',u)
306 x=read(u,2,4)
307 file('close',u)
308 //
309 u1=file('open',TMPDIR+'/foo','unknown')
310 u2=mopen(TMPDIR+'/foo1','wb')
311 [units,typs,nams]=file()
312 file('close',u1);
313 mclose(u2);
314  ]]></programlisting>
315     </refsection>
316     <refsection role="see also">
317         <title>参照</title>
318         <simplelist type="inline">
319             <member>
320                 <link linkend="isfile">isfile</link>
321             </member>
322             <member>
323                 <link linkend="read">read</link>
324             </member>
325             <member>
326                 <link linkend="readb">readb</link>
327             </member>
328             <member>
329                 <link linkend="write">write</link>
330             </member>
331             <member>
332                 <link linkend="writb">writb</link>
333             </member>
334             <member>
335                 <link linkend="mopen">mopen</link>
336             </member>
337             <member>
338                 <link linkend="save">save</link>
339             </member>
340             <member>
341                 <link linkend="load">load</link>
342             </member>
343             <member>
344                 <link linkend="uigetfile">uigetfile</link>
345             </member>
346         </simplelist>
347     </refsection>
348     <refsection role="history">
349         <title>履歴</title>
350         <revhistory>
351             <revision>
352                 <revnumber>6.0.0</revnumber>
353                 <revdescription>
354                     stderr is inserted in the output of file() as units(1)=0, typ(1)="STD" and
355                     nams(1)="stderr".
356                 </revdescription>
357             </revision>
358         </revhistory>
359     </refsection>
360 </refentry>