<?xml version="1.0" encoding="UTF-8"?>
<!--
 * Scilab ( https://www.scilab.org/ ) - This file is part of Scilab
 * Copyright (C) 2008 - INRIA - Allan CORNET
 * ...
 *
 * Copyright (C) 2012 - 2016 - Scilab Enterprises
 *
 * This file is hereby licensed under the terms of the GNU GPL v2.0,
 * pursuant to article 5.3.4 of the CeCILL v.2.1.
 * This file was originally licensed under the terms of the CeCILL v2.1,
 * and continues to be available under such terms.
 * For more information, see the COPYING file which you should have received
 * along with this program.
 *
 -->
<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="rmdir">
    <refnamediv>
        <refname>rmdir</refname>
        <refpurpose>удаляет директорию</refpurpose>
    </refnamediv>
    <refsynopsisdiv>
        <title>Синтаксис</title>
        <synopsis>
            rmdir(dirname)
            rmdir(dirname,'s')
            [status, message] = rmdir(dirname,'s')
        </synopsis>
    </refsynopsisdiv>
    <refsection>
        <title>Аргументы</title>
        <variablelist>
            <varlistentry>
                <term>dirname</term>
                <listitem>
                    <para>символьная строка: имя директории.</para>
                </listitem>
            </varlistentry>
            <varlistentry>
                <term>'s'</term>
                <listitem>
                    <para>
                        признак удаления директории  <varname>dirname</varname> с поддиректориями.
                    </para>
                </listitem>
            </varlistentry>
            <varlistentry>
                <term>status</term>
                <listitem>
                    <para>логическое значение: статус.</para>
                </listitem>
            </varlistentry>
            <varlistentry>
                <term>message</term>
                <listitem>
                    <para>
                        символьная строка: сообщение об ошибке.
                    </para>
                </listitem>
            </varlistentry>
        </variablelist>
    </refsection>
    <refsection>
        <title>Описание</title>
        <para>
            <code>rmdir(dirname)</code> удаляет директорию
            <varname>dirname</varname> из текущей директории. Если директория не
            пуста, вы должны использовать аргумент <constant>'s'</constant>. Если
            <varname>dirname</varname> нет в текущей директории, то укажите
            относительный путь до текущей директории или полный путь для
            <varname>dirname</varname>.
        </para>
        <para>
            <code>rmdir(dirname,'s')</code> удаляет директорию <varname>dirname</varname> и всё её содержимое из текущей директории.
        </para>
        <para>
            <code>[status, msg] = rmdir(dirname,'s')</code> удаляет директорию <varname>dirname</varname> и всё её содержимое из текущей директории, возвращая статус <varname>status</varname> и сообщение <varname>message</varname>. Здесь <varname>status</varname> равен 1 в случае успеха и равен 0 в случае ошибки.
        </para>
        <para>
            В любой операционной системе, если создание директории удалось, то статус <varname>status</varname> равен 1, а сообщение <varname>message</varname> пустое.
        </para>
    </refsection>
    <refsection>
        <title>Примеры</title>
        <programlisting role="example"><![CDATA[
mkdir(SCI,'Directory')
rmdir(SCI+'/Directory')
 ]]></programlisting>
    </refsection>
    <refsection role="see also">
        <title>Смотрите также</title>
        <simplelist type="inline">
            <member>
                <link linkend="createdir">createdir</link>
            </member>
            <member>
                <link linkend="mkdir">mkdir</link>
            </member>
            <member>
                <link linkend="removedir">removedir</link>
            </member>
        </simplelist>
    </refsection>
</refentry>

