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