Home
Reference Guides
Reference guides are available for functions and commands supported by OML, Tcl, and Python.
Reference Guide for OpenMatrix Language Functions
The Reference Guide contains documentation for all functions supported in the OpenMatrix language.
System Commands
rmdir
Removes the directory dir.

Welcome
What's New
Discover new features and enhancements.
Get Started
Discover Compose, including its language support and system requirements.
Tutorials
The Compose tutorials and associated example model files help introduce you to the basic functionality of the software.
User Guide
Learn about the features and functionality available in Compose.
Reference Guides
Reference guides are available for functions and commands supported by OML, Tcl, and Python.
- Scripting Guide for OpenMatrix Language
  OpenMatrix is a mathematical scripting language.
- Reference Guide for OpenMatrix Language Functions
  The Reference Guide contains documentation for all functions supported in the OpenMatrix language.
  - ABF Commands
  - Altair Integration Commands
  - Audio Commands
  - CAE Commands
  - CAE Reader Commands
  - CAE Reader 3D Commands
  - CAE Writer Commands
  - Calculus Commands
  - Computer Vision Commands
  - Communication Commands
  - Control System Commands
  - Core Minimal Interpreter Commands
  - Data Structure Commands
  - Differential Equations Commands
  - Elementary Math Commands
  - File I/O Commands
  - Geometry Commands
  - GUI Commands
  - HDF5 Reader Commands
  - HDF5 Writer Commands
  - hstpyfit Commands
  - Image Commands
  - JSON Commands
  - Library Manager Commands
  - Linear Algebra Commands
  - Logical Commands
  - Machine Learning Commands
  - Optimization Commands
  - Plotting Commands
  - PSIM Commands
  - Polynomial Math Commands
  - Signal Processing Commands
  - Special Functions Commands
  - Statistical Analysis Commands
  - String Operations Commands
  - System Commands
    - cd
      Changes the current directory to dir.
    - chdir
      Changes the current directory to dir.
    - cputime
      Returns the current cputime used by Compose.
    - createdistributable
      Create a distributable encrypted file to be used with Compose Light. The file is automatically recognized by the operating system as a Compose Light file.
    - date
      Returns the current date as a string in the format DD-MMM-YYYY.
    - delete
      Deletes the file(s), f, or a graphic object, h.
    - diary
      Records all commands and outputs of an interactive session to a file. If no arguments are passed, the diary state is toggled. To save outputs when running a script (non-interactive session), use outputlog.
    - dir
      Directory listing of the current or specified directory.
    - dos
      Executes a dos command on Windows.
    - encryptfile
      Encrypts a OML file.
    - filesep
      Returns the path separator, dependent on the system.
    - genpath
      Creates a path with the directory and sub-directories under dir.
    - getpid
      Returns the current process ID.
    - ls
      Displays information and contents of file(s) or directories.
    - make_absolute_filename
      Creates an absolute path with input name, without checks made for the existance of the path on disk.
    - mkdir
      Creates the directory newdir in the current working directory by default.
    - outputlog
      Records all outputs to a file. If no arguments are passed, the outputlog state is toggled.
    - rmdir
      Removes the directory dir.
    - startupscript_edit
      Opens the user startup script for editing (GUI application only).
    - startupscript_path
      Shows the path to the user startup script.
    - system
      Executes the shell command stringCommand. If executed in 'sync' mode or without additional inputs, the application waits until the execution is complete. If executed in 'async' mode, stringCommand is executed in a detached thread and control is returned to the application immediately.
    - unix
      Executes the unix shell command stringCommand.
  - Table Commands
  - Tcl Bridge OML Commands
  - Tcl Bridge Tcl Commands
  - Time Commands
  - Trigonometry Commands
  - OML to Python Bridge Commands
  - Python to OML Bridge Commands
- Python in Compose Reference Guide
Appendix
Get help for the optional libraries that are available in the Extension Manager.
Frequently Asked Questions
You've got questions? We've got answers!

rmdir

Removes the directory dir.

Syntax

rmdir dir

rmdir(dir)

rmdir(dir, 's')

[status, msg1, msg2] = rmdir(dir)

Inputs

dir: Name of the directory to be removed. It needs to be empty if option s is not specified.; Type: string
s: Additional option which specifies if the files and sub-directories under dir should be deleted.

Outputs

status: Returns 1 if successful; returns 0 if not successful.
msg1: If status is 1 (successful), msg1 is empty. If status is 0 (unsuccessful), msg1 contains an error mesage.
msg2: If status is 1 (successful), msg2 is empty. If status is 0 (unsuccessful), msg2 returns the command name 'rmdir'.

Examples

Simple rmdir successful example:

rmdir('C:/testdirectory')

ans = 1

Simple rmdir unsuccessful example with fail outputs:

[status, msg1, msg2] = rmdir('C:/testdirectory')

status = 0
msg1 = Problem removing directory
msg2 = rmdir

Remove a non-empty directory, along with all contents:

rmdir('C:/nonempty_testdirectory', 's')

ans = 1