[Overview][Constants][Types][Procedures and functions][Variables][Index] Reference for unit 'LazFileUtils' (#lazutils)

Reference for unit 'LazFileUtils': Procedures and functions

AppendPathDelim

  

Adds a trailing path delimiter when needed

CheckIfFileIsExecutable

  

Examines the specified file to see if it is executable

CheckIfFileIsSymlink

CheckPathDelim

ChompPathDelim

  

Removes a trailing path delimiter from the specified value

CleanAndExpandDirectory

  

Removes whitespace and resolves special characters in the specified path

CleanAndExpandFilename

  

Removes whitespace and resolve special characters in the specified file name

CompareFileExt

  

Performs a sort order comparision for the specified file name and extension

CompareFilenames

  

Gets the relative sort order for the specified file names

CompareFilenamesIgnoreCase

  

Gets the relative sort order for case-insensitive file names

CompareFilenamesP

CompareFilenameStarts

  

Compares file names using the number characters in common

CreateAbsolutePath

CreateAbsoluteSearchPath

CreateDirUTF8

  

Creates a new directory with the specified name

CreateRelativePath

  

Creates a relative path from BaseDirectory to Filename

CreateRelativeSearchPath

DbgSFileAttr

DeleteFileUTF8

  

Deletes the specified file name

DirectoryExistsUTF8

  

Determine if the specified path exists on the local file system

DirectoryIsWritable

  

Indicates if the specified directory name is writable

DirPathExists

  

Indicates if the specified directory name exists in the file system

ExpandFileNameUTF8

  

Expands the values in FileName and BaseDir to an absolute file name

ExtractFileNameOnly

  

Gets the base file name (without the file extension) in the specified path

ExtractFileNameWithoutExt

ExtractFileRoot

ExtractUNCVolume

FileAgeUTF8

  

Returns the last modification time for the file in FileDate format

FileCreateUTF8

FileExistsUTF8

  

Indicates if the specified file name exists

FileGetAttrUTF8

  

Gets the value of file attributes for the specified file name

FileIsExecutable

  

Determine if the specified file name is executable

FileIsHardLink

FileIsInPath

  

Returns True if Filename exists in the specified Path

FileIsReadable

  

Indicates if the specified file name is readable

FileIsReadOnlyUTF8

  

Determines if the specified file is marked as read-only

FileIsSymlink

FileIsText

  

Determine if the specified file contains plain text content

FileIsWritable

  

Indicates if the specified file name is writable

FilenameIsAbsolute

  

Determines if the specified value is an absolute file path (not a relative one)

FilenameIsTrimmed

  

FilenameIsUnixAbsolute

  

Determines if the specified value is an absolute file path (not a relative one)

FilenameIsWinAbsolute

  

Determines if the specified value is an absolute file path (not a relative one)

FileOpenUTF8

FileSearchUTF8

  

Searches for a file with the specified name in the list of directory paths

FileSetAttrUTF8

  

Sets the file attribute value for the specified file name

FileSetDateUTF8

  

Sets the last modification time for the file

FileSizeUtf8

FindCloseUTF8

  

Frees resources allocated to the specified search record

FindFirstUTF8

  

Starts searching for files matching the specified path value

FindNextUTF8

  

Locates another file matching the search criteria

FindPathInSearchPath

ForceDirectoriesUTF8

  

Creates the specified directories if they do not already exist

ForceDirectory

  

Creates the specified directory if it does not already exist

ForcePathDelims

GetAppConfigDirUTF8

GetAppConfigFileUTF8

GetCurrentDirUTF8

  

Gets the name for the current directory

GetFileDescription

GetForcedPathDelims

GetPhysicalFilename

GetShellLinkTarget

GetTempFileNameUTF8

InvalidateFileStateCache

  

Signals the OnInvalidateFileStateCache event handler

IsCurrentPathDelim

IsUNCPath

MergeCmdLineParams

MinimizeSearchPath

PrepareCmdLineOption

ReadAllLinks

  

Resolves a symbolic link to an actual file name

RemoveDirUTF8

  

Removes the directory with the specified name

RenameFileUTF8

  

Renames a file to the specified value

ResolveDots

  

Removes duplicate path delimiters and resolves . and ..

SetCurrentDirUTF8

  

Sets the current directory to the specified name

SplitCmdLine

SplitCmdLineParams

  

Splits command line parameters separated by whitespace characters

StrToCmdLineParam

SwitchPathDelims

TrimAndExpandDirectory

  

Cleans and resolves a relative path to a base directory

TrimAndExpandFilename

  

Cleans and resolves a file path to the specified base directory name

TrimFilename

  

Removes leading and trailing spaces, and resolves special characters

TryCreateRelativePath

TryReadAllLinks

  

Resolves a symlink to the real file

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