# rmdir

removes a directory

## Calling Sequence

                rmdir(dirname)
                rmdir(dirname,'s')
                [status, message] = rmdir(dirname,'s')

## Arguments

dirname

  a character string.

's'

  a mark to remove directory `dirname` with subdirectories.

status

  a boolean.

message

  a character string: a message about an error.

## Description

`rmdir(dirname)` removes the directory `dirname` from the current directory. If the directory is not empty, you must use the s argument. If `dirname` is not in the current directory, specify the relative path to the current directory or the full path for `dirname`.

`rmdir(dirname,'s')` removes the directory `dirname` and its contents from the current directory.

`[status, message] = rmdir(dirname,'s')` removes the directory `dirname` and its contents from the current directory, returning the status, and a message. Here, `status` is 1 for success and is 0 for error.

Whatever the operating system, if the removing of directory succeeds, the `status` is 1 and the message `message` is empty.

## Examples

    mkdir(SCI,'Directory')
    rmdir(SCI+'/Directory')

## See Also

- createdir
- mkdir
- removedir