Qu

remove_dir

Builtin index · File I/O

remove_dir(path, [recursive=false], [recycle_bin=false])

Input: path, recursive, recycle_bin · Output: no output

What it is

Deletes the directory path. Refuses a non-empty directory unless recursive=true — this check applies whether or not recycle_bin is set, since "may I remove a whole tree" and "should this be recoverable" are different questions.

Overloads

One call shape — this function is not overloaded.

CodeInputOutputDescription
remove_dir(path, [recursive=false], [recycle_bin=false])
path —Deletes the directory path.
recursive optional (default false)Refuses a non-empty directory unless recursive=true — this check applies whether or not recycle_bin is set, since "may I remove a whole tree" and "should this be recoverable" are different questions.
recycle_bin optional (default false)Refuses a non-empty directory unless recursive=true — this check applies whether or not recycle_bin is set, since "may I remove a whole tree" and "should this be recoverable" are different questions.
no output—

Examples

No documentation example calls this form yet. The File I/O chapter is where one belongs.