Qu

remove_file

Builtin index · File I/O

remove_file(path, [recycle_bin=false])

Input: path, recycle_bin · Output: no output

What it is

Deletes path (a Str). Errors if it does not exist or is not a regular file, rather than silently doing nothing. recycle_bin=true sends it to the OS Recycle Bin/Trash instead of deleting it permanently — default false keeps a script's existing behavior unchanged.

Overloads

One call shape — this function is not overloaded.

CodeInputOutputDescription
remove_file(path, [recycle_bin=false])
path StrDeletes path (a Str).
recycle_bin optional (default false)recycle_bin=true sends it to the OS Recycle Bin/Trash instead of deleting it permanently — default false keeps a script's existing behavior unchanged.
no outputErrors if it does not exist or is not a regular file, rather than silently doing nothing.

Examples

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