JCL Help:SHDeleteFolder

 JCL Help: SHDeleteFolder Function

Windows_Specific.Shell.FilesandFolders

JEDI Code Library Help

• Packages
  • RTL enhancements
  • Containers
  • Developer Tools
  • VCL enhancements
• Files
  • Classes
  • Interfaces
  • Functions
  • Variables
  • Constants
  • Types
  • Records
• Project summary
• License

Search in JCL Help

 

Search in all projects

 

Summary

Deletes the specified folder.

Pascal

 function SHDeleteFolder(Parent: THandle; const Folder: string; Options: TSHDeleteOptions): Boolean;

Parameters

Parameters	Description
Parent: THandle	Handle of the window to serve as the parent of any dialogs displayed by this function. Specify GetDesktopWindow to use the desktop as the parent.
const Folder: string	The folder to delete.
Options: TSHDeleteOptions	Set of options that control the behavior of this function. See TSHDeleteOptions for more information.

Return Value

If the function succeeds the result is True, otherwise it is False.

Description

SHDeleteFolder deletes the specified folder, either permanently or to the recycle bin depending on the Options parameter. Additionally the function provides visual feedback by displaying the familiar delete folder dialog you also see when deleting a folder through explorer.

See Also

TSHDeleteOptions SHDeleteFiles

About

Unit

JclShell

Donator

Marcel van Brakel

Contribute to this help topic

This documentation wiki is based on the collaborative effort of Project JEDI users. Your edits are welcome in order to improve documentation quality: edit this page

The JEDI Code Library source code is hosted at : link to view the current source code, link to the subversion repository