1335a1a70e8e3325d5282f5ca635625927906e1d
[scilab.git] / scilab / modules / fileio / help / ru_RU / listfiles.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) 2008 - INRIA
5  *
6  * Copyright (C) 2012 - 2016 - Scilab Enterprises
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" 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="ru" xml:id="listfiles">
17     <refnamediv>
18         <refname>listfiles</refname>
19         <refpurpose>список файлов</refpurpose>
20     </refnamediv>
21     <refsynopsisdiv>
22         <title>Синтаксис</title>
23         <synopsis>files = listfiles(paths [,flag,flagexpand])</synopsis>
24     </refsynopsisdiv>
25     <refsection>
26         <title>Аргументы</title>
27         <variablelist>
28             <varlistentry>
29                 <term>paths</term>
30                 <listitem>
31                     <para>
32                         матрица строк, указывающая набор имён путей (обычно
33                         оканчивающихся шаблоном, построенным с <literal>*</literal>).
34                     </para>
35                 </listitem>
36             </varlistentry>
37             <varlistentry>
38                 <term>flag, flagexpand</term>
39                 <listitem>
40                     <para>
41                         логические необязательные параметры (значение по умолчанию равно
42                         <constant>%t</constant>).
43                     </para>
44                 </listitem>
45             </varlistentry>
46             <varlistentry>
47                 <term>files</term>
48                 <listitem>
49                     <para>матрица строк.</para>
50                 </listitem>
51             </varlistentry>
52         </variablelist>
53     </refsection>
54     <refsection>
55         <title>Описание</title>
56         <para>
57             Функция <function>listfiles</function> может быть использована для
58             составления списка файлов, которые соответствуют шаблонам, указанным
59             одним из элементов путей. Шаблоны указываются Unix-команде
60             <command>ls</command> или Windows-команде <command>dir</command> для
61             получения информации о файлах. Таким образом, чтобы написать переносимый
62             Scilab-сценарий, следует указывать корректные знаки шаблонов для обеих
63             ОС. Заметьте, что выполняется преобразование имени пути и, например,
64             <literal>SCI/core/macros/*.sci</literal> является корректным шаблоном
65             как для Unix, так и для Windows.
66         </para>
67         <para>
68             Если <varname>flag</varname> равен ИСТИНЕ, то имена пути, указанные с
69             помощью <varname>paths</varname>, преобразуются в соответствии со
70             значением <code>getos() == 'Windows'</code> (см. также <link linkend="pathconvert">pathconvert</link>).
71             Более того, если <varname>flagexpand</varname> равен ИСТИНЕ, то
72             начальные строки, такие как <literal>SCIHOME</literal>,
73             <literal>SCI</literal> или <literal>~</literal> расширяются с помощью
74             переменных окружения.
75         </para>
76         <para>
77             Если входной путь является именем директории, то возвращаемые имена
78             файлов <varname>files</varname> относятся к этой директории.
79         </para>
80         <para>
81             Если входные пути содержат шаблон (например <literal>"/*"</literal>, <literal>"*.c"</literal>), то к возвращаемым именам файлов <varname>files</varname> добавляется начало входного пути.
82         </para>
83     </refsection>
84     <refsection>
85         <title>Примеры</title>
86         <programlisting role="example">
87             <![CDATA[
88 files=listfiles(['SCI/modules/core/macros/*.sci';'SCI/modules/core/macros/*.bin']);
89  ]]>
90         </programlisting>
91     </refsection>
92     <refsection>
93         <title>История</title>
94         <revhistory>
95             <revision>
96                 <revnumber>5.4.0</revnumber>
97                 <revremark>
98                     Если пути не являются одиночной строкой, то все возвращаемые файлы представляются единообразно в форме абсолютного пути.
99                 </revremark>
100             </revision>
101         </revhistory>
102     </refsection>
103     <refsection role="see also">
104         <title>Смотрите также</title>
105         <simplelist type="inline">
106             <member>
107                 <link linkend="findfiles">findfiles</link>
108             </member>
109             <member>
110                 <link linkend="basename">basename</link>
111             </member>
112             <member>
113                 <link linkend="pathconvert">pathconvert</link>
114             </member>
115         </simplelist>
116     </refsection>
117 </refentry>
118