[fileio] allow mopen and mclose to handle multiple files
[scilab.git] / scilab / modules / fileio / help / ja_JP / mget.xml
1 <?xml version="1.0" encoding="UTF-8"?>
2
3 <!--
4  * Scilab ( http://www.scilab.org/ ) - This file is part of Scilab
5  * Copyright (C) 2008 - INRIA
6  * ...
7  *
8  * Copyright (C) 2012 - 2016 - Scilab Enterprises
9  *
10  * This file is hereby licensed under the terms of the GNU GPL v2.0,
11  * pursuant to article 5.3.4 of the CeCILL v.2.1.
12  * This file was originally licensed under the terms of the CeCILL v2.1,
13  * and continues to be available under such terms.
14  * For more information, see the COPYING file which you should have received
15  * along with this program.
16  *
17  -->
18
19 <refentry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xmlns:svg="http://www.w3.org/2000/svg" xmlns:ns5="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="mget" xml:lang="ja">
20
21     <refnamediv>
22
23         <refname>mget</refname>
24
25         <refpurpose>
26
27             指定したバイナリ形式で
28
29             バイトまたはワードを読み込み, double に変換
30
31         </refpurpose>
32
33     </refnamediv>
34
35     <refnamediv xml:id="mgeti">
36
37         <refname>mgeti</refname>
38
39         <refpurpose>
40
41             指定したバイナリ形式で
42
43             バイトまたはワードを読み込み, int型に変換
44
45         </refpurpose>
46
47     </refnamediv>
48
49     <refsynopsisdiv>
50
51         <title>呼び出し手順</title>
52
53         <synopsis>
54
55             x = mget([n, type, fd])
56
57             x = mgeti([n, type, fd])
58
59         </synopsis>
60
61     </refsynopsisdiv>
62
63     <refsection>
64
65         <title>引数</title>
66
67         <variablelist>
68
69             <varlistentry>
70
71                 <term>n</term>
72
73                 <listitem>
74
75                     <para>正のスカラー: 読み込むデータの数.</para>
76
77                 </listitem>
78
79             </varlistentry>
80
81             <varlistentry>
82
83                 <term>fd</term>
84
85                 <listitem>
86
87                     <para>
88
89                         スカラー:
90
91                         <function>mopen</function>により返されたファイル記述子.
92
93                         <literal>-1</literal>は直近にオープンされたファイルを意味します.
94
95                         デフォルト値は<literal>-1</literal>です.
96
97                     </para>
98
99                 </listitem>
100
101             </varlistentry>
102
103             <varlistentry>
104
105                 <term>type</term>
106
107                 <listitem>
108
109                     <para>
110
111                         文字列: <varname>x</varname>の全エントリを書き込むために使用する
112
113                         バイナリフォーマットを指定.
114
115                     </para>
116
117                 </listitem>
118
119             </varlistentry>
120
121             <varlistentry>
122
123                 <term>x</term>
124
125                 <listitem>
126
127                     <para>浮動小数点数または整数値のベクトル</para>
128
129                 </listitem>
130
131             </varlistentry>
132
133         </variablelist>
134
135     </refsection>
136
137     <refsection>
138
139         <title>説明</title>
140
141         <para>
142
143             <function>mget</function> 関数は,
144
145             ストリームパラメータ<varname>fd</varname>により指定された入力の
146
147             データを読み込み,浮動小数点数データのベクトルを返します.
148
149         </para>
150
151         <para>
152
153             <function>mgeti</function> 関数は,
154
155             ストリームパラメータ<varname>fd</varname>により指定された入力の
156
157             データを読み込み,整数データのベクトルを返します.
158
159         </para>
160
161         <para>
162
163             ファイルポインタが現在指している場所からデータが読み込まれ,
164
165             適当にインジケータが進まされます.
166
167         </para>
168
169         <para>
170
171             <varname>type</varname>パラメータは変換指定子で,
172
173             以下のフラグ文字のどれか (デフォルト値は<literal>"l"</literal>)を設定できます:
174
175         </para>
176
177         <para>
178
179             <note>
180
181                 Windowsにおけるデフォルトの動作では,バイト13
182
183                 (<literal>0x0D</literal>)をスキップします.
184
185                 <literal>'b'</literal>を指定して<function>mopen</function>を
186
187                 コールする必要があります.
188
189                 例えば, 例外なく全てのバイトを読み込むには,
190
191                 <code>fd1 = mopen(file1,'rb')</code> とします.
192
193             </note>
194
195         </para>
196
197         <para>データ型:</para>
198
199         <variablelist>
200
201             <varlistentry>
202
203                 <term>d</term>
204
205                 <listitem>
206
207                     <para>double</para>
208
209                 </listitem>
210
211             </varlistentry>
212
213             <varlistentry>
214
215                 <term>f</term>
216
217                 <listitem>
218
219                     <para>float</para>
220
221                 </listitem>
222
223             </varlistentry>
224
225             <varlistentry>
226
227                 <term>l</term>
228
229                 <listitem>
230
231                     <para>long</para>
232
233                 </listitem>
234
235             </varlistentry>
236
237             <varlistentry>
238
239                 <term>i</term>
240
241                 <listitem>
242
243                     <para>int</para>
244
245                 </listitem>
246
247             </varlistentry>
248
249             <varlistentry>
250
251                 <term>s</term>
252
253                 <listitem>
254
255                     <para>short</para>
256
257                 </listitem>
258
259             </varlistentry>
260
261             <varlistentry>
262
263                 <term>c</term>
264
265                 <listitem>
266
267                     <para>character</para>
268
269                 </listitem>
270
271             </varlistentry>
272
273         </variablelist>
274
275         <para>オプションのフラグ:</para>
276
277         <variablelist>
278
279             <varlistentry>
280
281                 <term>u..</term>
282
283                 <listitem>
284
285                     <para>符号なし (上記の型のどれかと組み合わせます)</para>
286
287                 </listitem>
288
289             </varlistentry>
290
291             <varlistentry>
292
293                 <term>..l</term>
294
295                 <listitem>
296
297                     <para>リトルインディアン (上記の型のどれかと組み合わせます)</para>
298
299                 </listitem>
300
301             </varlistentry>
302
303             <varlistentry>
304
305                 <term>..b</term>
306
307                 <listitem>
308
309                     <para>ビッグインディアン (上記の型のどれかと組み合わせます)</para>
310
311                 </listitem>
312
313             </varlistentry>
314
315         </variablelist>
316
317         <para>
318
319             (<literal>little=endian</literal>ステータスをチェックすることにより)
320
321             読み込まれたバイトは必要に応じて自動的にスワップされます.
322
323         </para>
324
325         <para>
326
327             このデフォルトのスワップ動作は
328
329             <function>mopen</function>関数にフラグを追加することにより抑制することが
330
331             できます.
332
333         </para>
334
335         <para>
336             フォーマット <literal>"l"</literal>, <literal>"d"</literal>
337
338             および <literal>"f"</literal> は, <function>mget</function>
339
340             関数でのみ有効です.
341
342         </para>
343
344     </refsection>
345
346     <refsection>
347
348         <title>例</title>
349
350         <programlisting role="example"><![CDATA[
351 file1 = fullfile(TMPDIR,'test1.bin');
352 file2 = fullfile(TMPDIR,'test2.bin');
353 fd1=mopen(file1,'wb');
354 fd2=mopen(file2,'wb');
355 mput(1996,'ull',fd1);
356 mput(1996,'ull',fd2);
357 mclose(fd1);
358 mclose(fd2);
359 fd1=mopen(file1,'rb');
360 if 1996<>mget(1,'ull',fd1)
361   write(%io(2),'Bug');
362 end
363
364 fd2=mopen(file2,'rb');
365 if 1996<>mget(1,'ull',fd2)
366   write(%io(2),'Bug');
367 end
368
369 mclose(fd1);
370 mclose(fd2);
371  ]]></programlisting>
372
373     </refsection>
374
375     <refsection role="see also">
376
377         <title>参照</title>
378
379         <simplelist type="inline">
380
381             <member>
382
383                 <link linkend="mclose">mclose</link>
384
385             </member>
386
387             <member>
388
389                 <link linkend="meof">meof</link>
390
391             </member>
392
393             <member>
394
395                 <link linkend="mfprintf">mfprintf</link>
396
397             </member>
398
399             <member>
400
401                 <link linkend="fprintfMat">fprintfMat</link>
402
403             </member>
404
405             <member>
406
407                 <link linkend="mfscanf">mfscanf</link>
408
409             </member>
410
411             <member>
412
413                 <link linkend="fscanfMat">fscanfMat</link>
414
415             </member>
416
417             <member>
418
419                 <link linkend="mgetl">mgetl</link>
420
421             </member>
422
423             <member>
424
425                 <link linkend="mgetstr">mgetstr</link>
426
427             </member>
428
429             <member>
430
431                 <link linkend="mopen">mopen</link>
432
433             </member>
434
435             <member>
436
437                 <link linkend="mprintf">mprintf</link>
438
439             </member>
440
441             <member>
442
443                 <link linkend="mput">mput</link>
444
445             </member>
446
447             <member>
448
449                 <link linkend="mputl">mputl</link>
450
451             </member>
452
453             <member>
454
455                 <link linkend="mputstr">mputstr</link>
456
457             </member>
458
459             <member>
460
461                 <link linkend="mscanf">mscanf</link>
462
463             </member>
464
465             <member>
466
467                 <link linkend="mseek">mseek</link>
468
469             </member>
470
471             <member>
472
473                 <link linkend="mtell">mtell</link>
474
475             </member>
476
477             <member>
478
479                 <link linkend="mdelete">mdelete</link>
480
481             </member>
482
483         </simplelist>
484
485     </refsection>
486
487 </refentry>
488