Name

Folder.Delete Method

Syntax

                  oFolderObj
                  .Delete [Force]
oFolderObj

Use: Required

Data Type: Folder object

A Folder object.

Force

Use: Optional

Data Type: Boolean

If set to True, any read-only flag on a file or a folder to be deleted is ignored and the file or folder is deleted. When set to False, a read-only flag prevents that folder or file from being deleted. Its default value is False.

Description

Removes the folder specified by the Folder object and all its files and subfolders.

Rules at a Glance

  • If any of the files within the folder are open, the method fails with a “Permission Denied” error.

  • The Delete method deletes all the contents of the given folder, including subfolders and their contents.

  • The default setting for Force is False. If any of the files in the folder or its subfolders are set to read-only, the method will fail.

  • If Force is set to False and any of the files in the folders are set to read-only, the method fails.

Programming Tips and Gotchas

  • The Delete method deletes a folder and its files and subfolders permanently; it does not move the folder or its files and subfolders to the Recycle Bin.

  • If an error occurs while deleting more than one file in the folder, the Delete method exits immediately, thereby leaving the rest of the folders or files undeleted. There is also no rollback facility to undo the deletions prior to the error.

  • Unlike the FileSystemObject’s DeleteFolder method, which accepts wildcard characters in the path parameter and can therefore delete multiple folders, ...

Get VBScript in a Nutshell, 2nd Edition now with the O’Reilly learning platform.

O’Reilly members experience books, live events, courses curated by job role, and more from O’Reilly and nearly 200 top publishers.