fRemoveDir (Function)

ONLINE HELP
FOR WINDEV, WEBDEV AND WINDEV MOBILE

Version:

Home | Sign in | English

Functions for managing external files

fRemoveDir

Presentation

Example

Operating mode in Windows Vista (and later)

Equivalence

See also

Constants for the external files

Functions for managing external files

Handling the external files

Storing files in Android

Summary table: Managing the application directories according to the platform

fDetectRemovableStorage

fReadLineRegularExpression

fRemoveDir

fRename

fReportsAndQueriesDir

Operating mode in Windows Vista (and later)
Equivalence

WINDEV

WEBDEV

WINDEV Mobile

Others

See also

fRemoveDir (Function)

In french: fRepSupprime

Deletes a directory from a disk.

Notes:

The user must have the rights to delete a directory.
A directory currently browsed by fDir or fListFile cannot be deleted.

Deletes a directory from the server disk. The Internet Guest account must have the rights to delete a directory.

Versions 15 and later

This function is now available for Android applications.

New in version 15

This function is now available for Android applications.

Versions 16 and later

This function is now available for Windows Phone applications.

New in version 16

This function is now available for Windows Phone applications.

Versions 17 and later

This function is now available for iPhone/iPad applications.

New in version 17

This function is now available for iPhone/iPad applications.

Versions 18 and later

This function is now available in Android Widget mode.

This function is now available in Windows Store apps mode.

New in version 18

This function is now available in Android Widget mode.

This function is now available in Windows Store apps mode.

This function is now available in Android Widget mode.

This function is now available in Windows Store apps mode.

Versions 21 and later

This function is now available in Universal Windows 10 App mode.

New in version 21

This function is now available in Universal Windows 10 App mode.

Example

See additional examples

// Delete a directory
ResDelete = fRemoveDir("C:\MyDirectories\MyFiles")

// Delete a directory
ResDelete = fRemoveDir("\MyDirectories\MyFiles")

Syntax

<Result> = fRemoveDir(<Directory to delete> [, <Deletion indicator>])

<Result>: Boolean

True if the directory was deleted,
False otherwise. To find out the error details, use ErrorInfo associated with the errMessage constant.

<Directory to delete>: Character string (with quotes)

Name and full (or relative) path of directory to delete. A UNC path can be used. The wildcard characters (*,?) are ignored. This directory name may (or may not) end with "\".
Versions 15 and later
This parameter can be in Ansi or Unicode format.
New in version 15
This parameter can be in Ansi or Unicode format.
This parameter can be in Ansi or Unicode format.
This path must be a full path or a UNC path. It cannot be a relative path.
Only the directories found in the directory of the application can be handled.

<Deletion indicator>: Optional constant

frReadOnly Also deletes the read-only files. If this constant is not specified, the function will return False if read-only files must be deleted.
This constant is not available.
frRecursive The contents of directory and sub-directories are also deleted. If this constant is not specified, the directory must be empty in order to be deleted.
frToRecycleBin Sends the directory to the Windows bin instead of deleting it.
This constant is not available.
<Deletion indicator> is empty by default. None of these options is selected.

Remarks

Operating mode in Windows Vista (and later)

If this function does not operate properly in Windows Vista (and later), check whether the file used is not found in one of the system directories (Windows directory or "Program Files" directory).

Indeed, in Windows Vista (and later), with the UAC mechanism (User Account Control) enabled, you must have the administrator privileges to handle and/or modify the files found in the system directories (Windows directory or "Program Files" directory).

Programming tip: To handle and/or modify the files without having administrator privileges, you should:

avoid writing into the Windows directory or into the "Program Files" directory,
use the system directory corresponding to the application (returned by SysDir associated with the srCommonAppData constant).

Equivalence

The operating mode of fRemoveDir is equivalent to the operating mode of ceRemoveDir.

The only difference is:

fRemoveDir deletes a directory found on the Pocket PC from a WINDEV Mobile application.
ceRemoveDir deletes a Pocket PC directory from a standard WINDEV application.

Component : wd240std.dll