* Bug #15472 fixed - mdelete('test') worked like mdelete('test.*') under Windows
[scilab.git] / scilab / modules / fileio / help / ja_JP / listfiles.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"
20           xmlns:svg="http://www.w3.org/2000/svg" xmlns:mml="http://www.w3.org/1998/Math/MathML"
21           xmlns:db="http://docbook.org/ns/docbook" xmlns:scilab="http://www.scilab.org"
22           xml:lang="ja" xml:id="listfiles">
23
24     <refnamediv>
25
26         <refname>listfiles</refname>
27
28         <refpurpose>ファイルのリスト</refpurpose>
29
30     </refnamediv>
31
32     <refsynopsisdiv>
33
34         <title>呼び出し手順</title>
35
36         <synopsis>files = listfiles(paths [, flag, flagexpand])</synopsis>
37
38     </refsynopsisdiv>
39
40     <refsection>
41
42         <title>引数</title>
43
44         <variablelist>
45
46             <varlistentry>
47
48                 <term>paths</term>
49
50                 <listitem>
51
52                     <para>
53
54                         パス名の集合を指定する文字列の行列
55
56                         (多くの場合, 末尾が <literal>*</literal> のパターンとなります)
57
58                     </para>
59
60                 </listitem>
61
62             </varlistentry>
63
64             <varlistentry>
65
66                 <term>flag, flagexpand</term>
67
68                 <listitem>
69
70                     <para>
71
72                         オプションの論理値パラメータ
73
74                         (デフォルト値は<constant>%t</constant>です).
75
76                     </para>
77
78                 </listitem>
79
80             </varlistentry>
81
82             <varlistentry>
83
84                 <term>files</term>
85
86                 <listitem>
87
88                     <para>文字列の行列.</para>
89
90                 </listitem>
91
92             </varlistentry>
93
94         </variablelist>
95
96     </refsection>
97
98     <refsection>
99
100         <title>説明</title>
101
102         <para>
103
104             <function>listfiles</function> は,
105
106             パスエントリの指定したパターンのどれかに一致するファイル
107
108             の一覧を得るために使用されます.
109
110             パターンは,ファイルに関する情報を取得するために
111
112             Unixでは<command>ls</command>,Windowsでは
113
114             <command>dir</command>コマンドに指定されます.
115
116             このため, ポータブルなScilabスクリプトを書くためには,
117
118             両方のOSに有効なワイルドカードパターンを指定する必要があります.
119
120             パス名の変換が行われ,例えば<literal>SCI/core/macros/*.sci</literal>
121
122             はUnixとWindowsの両方で有効なパターンであることに注意してください.
123
124         </para>
125
126         <para>
127
128             <varname>flag</varname> が真の場合,<varname>paths</varname>で
129
130             指定したパス名は <code>getos() == 'Windows'</code> の値に基づき変換されます
131
132             (<link linkend="pathconvert">pathconvert</link>参照).
133
134             さらに,<varname>flagexpand</varname> が真の場合,
135
136             <literal>HOME</literal>, <literal>SCI</literal> または <literal>~</literal> のような
137
138             主要な文字列は環境変数を用いて展開されます.
139
140         </para>
141
142         <para>
143
144             入力引数 <varname>paths</varname> がディレクトリ名の場合,
145
146             返される<varname>files</varname>はディレクトリのネーティブな名前です.
147
148         </para>
149
150         <para>
151
152             入力引数<varname>paths</varname>が複数の要素を有する場合,または
153
154             パターン<varname>files</varname>
155
156             (例: <literal>"/*"</literal>, <literal>"*.c"</literal>)を有する場合,
157
158             返される<varname>files</varname>は絶対パス
159
160             (すなわち,ディレクトリ名の末尾にファイル名を追加したもの)です.
161
162         </para>
163
164     </refsection>
165
166     <refsection>
167
168         <title>例</title>
169
170         <programlisting role="example"><![CDATA[
171 files=listfiles(['SCI/modules/core/macros/*.sci';'SCI/modules/core/macros/*.bin']);
172  ]]>
173
174         </programlisting>
175
176     </refsection>
177
178     <refsection>
179
180         <title>履歴</title>
181
182         <revhistory>
183
184             <revision>
185
186                 <revnumber>5.4.0</revnumber>
187
188                 <revremark>
189
190                     pathsが単一の文字列でない場合,
191
192                     返されるファイルは全て絶対パス形式に統一されます.
193
194                 </revremark>
195
196             </revision>
197
198         </revhistory>
199
200     </refsection>
201
202     <refsection role="see also">
203
204         <title>参照</title>
205
206         <simplelist type="inline">
207
208             <member>
209
210                 <link linkend="findfiles">findfiles</link>
211
212             </member>
213
214             <member>
215
216                 <link linkend="basename">basename</link>
217
218             </member>
219
220             <member>
221
222                 <link linkend="pathconvert">pathconvert</link>
223
224             </member>
225
226         </simplelist>
227
228     </refsection>
229     <refsection>
230         <title>履歴</title>
231         <revhistory>
232             <revision>
233                 <revnumber>5.4.0</revnumber>
234                 <revremark>If paths is not a single string, all returned files are homogenized
235                   with the absolute path form.
236                 </revremark>
237             </revision>
238             <revision>
239                 <revnumber>6.0.2</revnumber>
240                 <revremark>
241                     Under Windows, up to 6.0.1, <literal>listfile("test")</literal> actually
242                     performed <literal>listfile("test.*")</literal>. It is no longer the case.
243                 </revremark>
244             </revision>
245         </revhistory>
246     </refsection>
247
248 </refentry>
249