[Overview][Constants][Types][Classes][Procedures and functions][Index] Reference for unit 'FileUtil' (#lcl)

Reference for unit 'FileUtil': Procedures and functions

AppendPathDelim

  

Appends the path delimeter to the path.

CheckIfFileIsExecutable

  

CheckIfFileIsExecutable - creates Exception if file is not Executable

CheckIfFileIsSymlink

  

CheckIfFileIsSymlink - raises an exception if file is not a Symbolic Link

ChompPathDelim

  

Removes trailing path delimeter

CleanAndExpandDirectory

  

CleanAndExpandDirectory - trims and cleans FileName and appends a directory delimiter to it

CleanAndExpandFilename

  

CleanAndExpandFilename - trims irrelevant characters such as path delimiters from the name of the file

CompareFileExt

  

CompareFileExt - see whether the nominated file has an extension that is the same as the supplied extension

CompareFilenames

  

CompareFileNames - compares two file names to see whether they are equal

CompareFilenamesIgnoreCase

ConsoleToUTF8

CopyFile

  

CopyFile - copies Source file to Destination file, optionally preserving the time stamp of the original file

CreateAbsolutePath

CreateAbsoluteSearchPath

  

CreateAbsoluteSearchPath - concatenates BaseDirectory and SearchPath to form an absolute path to search for files

CreateDirUTF8

CreateRelativePath

  

CreateRelativePath - given an absolute file path and aBaseDirectory, create a file path relative to the given base directory

DeleteDirectory

  

DeleteDirectory - Delete the named directory (or only its contents if OnlyChilds is True)

DeleteFileUTF8

DirectoryExistsUTF8

DirectoryIsWritable

  

DirectoryIsWritable - checks if it is possible to write a file to the named directory

DirPathExists

  

Checks if the given directory path exists

ExpandFileNameUTF8

ExpandUNCFileNameUTF8

ExtractFileNameOnly

  

ExtractFileNameOnly - removes all path delimiters and file extensions, leaving just the file name

ExtractFileNameWithoutExt

  

ExtractFileNameWithoutExt - returns just the name of the file without an extension

ExtractShortPathNameUTF8

FileAgeUTF8

FileExistsUTF8

FileGetAttrUTF8

FileIsExecutable

  

FileIsExecutable - checks if AFileName refers to an executable file

FileIsInDirectory

  

FileIsInDirectory - checks whether a file with FileName exists within the given Directory

FileIsInPath

  

FileIsInPath - checks that FileName refers to a file that exists within the given Path

FileIsReadable

  

FileIsReadable - checks whether supplied file name refers to a readable file

FileIsReadOnlyUTF8

FileIsSymlink

  

FileIsSymLink - check if file name is a symbolic link

FileIsText

  

FileIsText - checks whether the supplied file name refers to a readable text file

FileIsWritable

  

FileIsWritable - checks if the supplied file name refers to a file that is writable

FilenameIsAbsolute

  

Checks whether an absolute file name is given in TheFileName

FilenameIsPascalUnit

  

FilenameIsPascalUnit - checks that the supplied name is a correct Pascal unit name

FilenameIsUnixAbsolute

  

FilenameIsUnixAbsolute - checks that the supplied name is an absolute filename in Unix systems

FilenameIsWinAbsolute

  

FilenameIsWinAbsolute - checks that the supplied name is an absolute file name for the Windows system

FileSearchUTF8

FileSetAttrUTF8

FileSetDateUTF8

FileSize

  

FileSize - finds the size of the named file

FindAllFiles

  

Returns the list of found files in the specified path according to passed options.

FindCloseUTF8

FindDefaultExecutablePath

  

FindDefaultExecutablePath - finds the default path to the named Executable file

FindDiskFileCaseInsensitive

  

FindDiskFileCaseInsensitive - searches for the given FileName in a case insensitive manner

FindDiskFilename

  

FindDiskFilename - finds the file that best fits the supplied filename

FindFirstUTF8

FindNextUTF8

ForceDirectoriesUTF8

ForceDirectory

  

ForceDirectory - creates a directory if none exists

GetAllFilesMask

  

File mask representing all files suitable for showing in a file filter.

GetAppConfigDirUTF8

GetAppConfigFileUTF8

GetCurrentDirUTF8

GetEnvironmentStringUTF8

GetEnvironmentVariableUTF8

GetExeExt

  

GetExeExt - find the correct extension for an executable file

GetFileDescription

  

GetFileDescription - finds the Unix-type file description for the given file

GetTempFilename

  

GetTempFilename - finds a suitable name for a temporary file

NeedRTLAnsi

ParamStrUTF8

ProgramDirectory

  

ProgramDirectory - returns the directory in which the currently running program resides

ReadAllLinks

  

ReadAllLinks - tries to find the file that is referred to by the symbolic link in FileName

ReadFileToString

  

ReadFileToString - returns a string with the contents of the named file

RemoveDirUTF8

RenameFileUTF8

SearchAllFilesInPath

  

SearchAllFilesInPath - searches for all files named Filename in the given SearchPath using the supplied BasePath with the specified Delimiter and the options listed in Flags

SearchFileInPath

  

SearchFileInPath - searches for Filename in the given SearchPath using the supplied BasePath with the specified Delimiter and the options listed in Flags

SetCurrentDirUTF8

SetNeedRTLAnsi

SysErrorMessageUTF8

SysToUTF8

TrimFilename

  

TrimFilename - trim double path delimiters, heading and trailing spaces and special dirs . and ..

TryReadAllLinks

UTF8ToConsole

UTF8ToSys

The latest version of this document can be found at lazarus-ccr.sourceforge.net.