Delete Function

Owning Palette: Advanced File VIs and Functions

Requires: Base Development System

Deletes the file or directory specified by path. This function does not work for files inside an LLB.

Details  

Add to the block diagram

Find on the palette

	prompt is the message that appears above the list of files and directories, or folder, in the file dialog box.
	path specifies the absolute path to the file or directory you want to delete. If path is empty (default), the function displays a dialog box from which you can select a file or directory. If you specify an empty or relative path, this function returns an error. cancelled is TRUE if you cancel the dialog box.
	entire hierarchy determines whether this function deletes all contents in the folder. The default is FALSE. If entire hierarchy is TRUE, this function deletes all files and folders within the specified path.
	If confirm is TRUE, the function displays a dialog box and asks you to confirm the delete operation. The default is FALSE.
	error in describes error conditions that occur before this node runs. This input provides standard error in functionality.
	deleted path is the path of the deleted file or folder. deleted path returns <Not A Path> if an error occurred.
	cancelled is TRUE if you cancel the file dialog box. Otherwise, cancelled is FALSE, even if this function returns an error.
	error out contains error information. This output provides standard error out functionality.

Delete Details

If path specifies a directory that is not empty or if you do not have write permission for the file or directory specified by path and its parent directory, this function does not remove the directory and returns an error. Set entire hierarchy to TRUE to set the function to delete non-empty directories. Use the Set Permissions function to set the permissions for a file or directory.