Sign in Join
FPDoc Onlineexperiment

RemoveDirUTF8 function

In unit LazFileUtils

Removes the directory with the specified name.

Declaration

pascal
function RemoveDirUTF8(const Dir: string): Boolean

Arguments

Dir

Name of the directory to remove in the function.

Function result

True when the directory is successfully removed.

Description

RemoveDirUTF8 is a Boolean function used to remove the directory with the specified name from the local file system.

For the Windows environment, UTF8Decode is called to convert the value in Dir to wide string format. The RemoveDirectoryW function in the Windows unit is called to remove the specified directory.

For UNIX-like environments, RemoveDir in SysUtils is called to remove the specified directory.

The return value is True when the specified directory is successfully removed.

See also

An experiment, built from development snapshots. Not the official Free Pascal or Lazarus documentation.