func_file_deletedir.rst 527 B

123456789101112131415161718192021222324252627282930313233343536373839404142
  1. .. _func_file_deletedir:
  2. =========
  3. DeleteDir
  4. =========
  5. DeleteDir -
  6. Description
  7. ===========
  8. .. code-block:: blitzmax
  9. DeleteDir( path$,recurse=False )
  10. Delete a directory
  11. Set @recurse to true to delete all subdirectories and files recursively -
  12. but be careful!
  13. Parameters
  14. ==========
  15. Return Values
  16. =============
  17. True if successful
  18. Examples
  19. ========
  20. .. code-block:: blitzmax
  21. ' deletedir.bmx
  22. success=deletedir("myfolder")
  23. if not success runtimeerror "error deleting directory"
  24. See Also
  25. ========