fDelete (Function)

ONLINE HELP
WINDEV, WEBDEV AND WINDEV MOBILE

Version:

Home | Sign in | English

This content has been translated automatically. Click here to view the French version.

Help / WLanguage / WLanguage functions / Standard functions / External file functions

Error management
Operating mode in Windows Vista (and later)

WINDEV

WEBDEV

WINDEV Mobile

Others

See also

fDelete (Function)

In french: fSupprime

Deletes a file accessible from the current computer.

Example

See additional examples

// Suppression d'un fichier
ResSupprimer = fDelete("C:\MesRépertoires\Fichier.doc")
// ------------------
let nRes = fDelete("C:\mes projets\Mon Fichier.txt")
IF nRes = False THEN ErrorInfo(errMessage)

Syntax

<Result> = fDelete(<File name> [, <Option>])

<Result>: Boolean

True if the file was deleted,
False otherwise. To get more details on the error, use ErrorInfo with the errMessage constant.

<File name>: Character string

Name of the file to delete. This parameter can correspond to:
a file name. This file will be automatically searched in the current directory (returned by fCurrentDir).
a file name with its full or relative path. A UNC path can be used.
Wildcard characters (*,?) are allowed in the file name.
If no drive is specified, the file will be deleted from the current drive.
If the "*.*" expression is used, only the files that have an extension will be deleted.
This parameter can be in Ansi or Unicode format.
This parameter can correspond to a full path or a path relative to the current directory (returned by fCurrentDir). This parameter is case-sensitive.
Reminder: In Android, the file system is read-only on the device and on the emulator. An application can only write to its installation directory or one of its subdirectories, as well as to the external memory (SDCard).
This parameter can correspond to a full path or a path relative to the current directory (returned by fCurrentDir). This parameter is case-sensitive.
Reminder Under iPhone/iPad, on both the device and the emulator, the file system is read-only. An application can only write to its installation directory or one of its subdirectories.

<Option>: Optional constant

Type of deletion to perform:
frReadOnly Automatically deletes the read-only files (without confirmation).
frToRecycleBin Sends the file to the Windows recycle bin instead of deleting it.
This constant is not available.
This parameter is not available.

Remarks

Error management

fDelete throws an error in the following cases:

the file to delete does not exist,
the file to delete is open or locked,
the user has no read or write rights on the file to delete.

Operating mode in Windows Vista (and later)

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

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

Programming tip: If you need to manipulate / modify files or directories, without needing administrator privileges, it is advisable:

avoid writing to the Windows directory or to the "Program Files" directory,
use the system directory of the application (returned by SysDir with the srAppDataCommun constant, for example).

Component: wd300std.dll