LazFileUtils unit

Contains types, procedures, and functions used for file and directory operations.

lazfileutils.pas contains types, procedures, and functions used for file and directory operations. lazfileutils.pas is part of the LazUtils package.

All functions are thread-safe unless explicitly stated.

Classes and records

`TRawbyteSearchRecHelper`	helper	Record Helper for the TRawbyteSearchRecHelper record type.
`TUnicodeSearchRecHelper`	helper	Record Helper for the TUnicodeSearchRec record type.

Procedures and functions

`AppendPathDelim`	function	Adds a trailing path delimiter to the specified path (when needed).
`CheckIfFileIsExecutable`	procedure	Examines the specified file to see if it is executable.
`CheckIfFileIsSymlink`	procedure	Checks whether the specified file name is a symbolic link on the local file system.
`CheckPathDelim`	function	Determines if the specified path delimiter character is not used on the system.
`ChompPathDelim`	function	Removes a trailing path delimiter from the specified value.
`CleanAndExpandDirectory`	function	Removes whitespace and resolves special characters in the specified path.
`CleanAndExpandFilename`	function	Removes whitespace and resolves special characters in the specified file name.
`CompareFileExt`	function	Compares the extension in a file name to a given value and returns the relative order.
`CompareFilenames`	function	Gets the relative sort order for the specified file names.
`CompareFilenamesIgnoreCase`	function	Gets the relative sort order for case-insensitive file names.
`CompareFilenamesP`	function	Compares file names to determine their relative sort order.
`CompareFilenameStarts`	function	Compares file names using the number characters in common.
`CreateAbsolutePath`	function	Returns an absolute path relative to the specified base directory (when needed).
`CreateAbsoluteSearchPath`	function	Concatenates BaseDirectory and SearchPath to form an absolute path to search for files.
`CreateDirUTF8`	function	Creates a new directory with the specified name.
`CreateRelativePath`	function	Gets the relative path from BaseDirectory to Filename.
`CreateRelativeSearchPath`	function	Resolves relative path value(s) in the specified search path.
`DbgSFileAttr`	function	Generates a debugger message with information about the specified file attributes.
`DeleteFileUTF8`	function	Deletes the specified file name.
`DirectoryExistsUTF8`	function	Determine if the specified path exists on the local file system.
`DirectoryIsWritable`	function	Indicates if the specified directory name is writable.
`DirPathExists`	function	Indicates if the specified directory name exists on the local file system.
`ExpandFileNameUTF8`	function	Expands the values in FileName and BaseDir to an absolute file name.
`ExtractFileNameOnly`	function	Gets the base file name (without the file extension) in the specified path.
`ExtractFileNameWithoutExt`	function	Gets the value from AFilename prior to the '.' character that starts the file extension.
`ExtractFileRoot`	function	Gets the root drive/path/directory for the specified file name.
`ExtractUNCVolume`	function	Gets UNC host and volume name used in the specified path.
`FileAgeUTF8`	function	Returns the last modification time for the file as an Int64 value.
`FileCreateUTF8`	function	Creates the specified file and returns its file handle.
`FileExistsTreatPackageAsFile`	function
`FileExistsUTF8`	function	Indicates if the specified UTF-8-encoded file name exists.
`FileGetAttrUTF8`	function	Gets the value of file attributes for the specified file name.
`FileIsExecutable`	function	Determines if the specified file name is executable.
`FileIsHardLink`	function	Indicates if the specified file has a descriptor or handle on the local file system.
`FileIsInPath`	function	Returns True if Filename exists in the specified Path.
`FileIsReadable`	function	Indicates if the specified file name is readable.
`FileIsReadOnlyUTF8`	function	Determines if the specified file is marked as read-only.
`FileIsSymlink`	function	Indicates if the specified file is a symbolic link in the file system.
`FileIsText`	function	Determines if the specified file contains plain text content.
`FileIsWritable`	function	Indicates if the specified file name is writable.
`FilenameExtIn`	function	Determines if the file name uses one of the specified file extensions.
`FilenameExtIs`	function	Determines if Filename has the specified file extension.
`FilenameIsAbsolute`	function	Determines if the specified value is an absolute file path (not a relative one).
`FilenameIsTrimmed`	function	True if the specified file name contains characters to remove or resolve before use.
`FilenameIsUnixAbsolute`	function	Determines if the specified value is an absolute file path (not a relative one).
`FilenameIsWinAbsolute`	function	Determines if the specified value is an absolute file path (not a relative one).
`FileOpenUTF8`	function	Opens the specified file name and returns its file handle.
`FileSearchUTF8`	function	Searches for a file with the specified name in the list of directory paths.
`FileSetAttrUTF8`	function	Sets the file attribute value for the specified file name.
`FileSetDateUTF8`	function	Sets the last modification time for the file.
`FileSizeUtf8`	function	Gets the size for the specified file name.
`FindCloseUTF8`	procedure	Frees resources allocated to the specified search record.
`FindFirstUTF8`	function	Starts searching for files matching the specified path value.
`FindNextUTF8`	function	Locates another file matching the search criteria.
`FindPathInSearchPath`	function	Locates the specified path in a delimited list of search paths.
`ForceDirectoriesUTF8`	function	Creates the directories specified in Dir if they do not already exist.
`ForceDirectory`	function	Creates the specified directory if it does not already exist.
`ForcePathDelims`	procedure	Ensures that path delimiters in the specified file name are correct for the current platform or OS.
`GetAppConfigDirUTF8`	function	Gets the directory for application configuration and data files.
`GetAppConfigFileUTF8`	function	Gets a UTF-8-encoded configuration file name for the current application.
`GetCurrentDirUTF8`	function	Gets the name for the current directory.
`GetFileDescription`	function	Gets descriptive information for the specified file name.
`GetForcedPathDelims`	function	Performs path delimiter substitutions for the specified file name.
`GetLazNormalizedFilename`	function	Gets a normalized form of the Filename.
`GetPermissions`	function
`GetPhysicalFilename`	function	Gets the physical file name for a symbolic link on the local file system.
`GetShellLinkTarget`	function	Resolves a Shell Link to the file path for the shortcut.
`GetTempFileNameUTF8`	function	Gets a temporary file name using the specified UTF-8-encoded path and prefix.
`GetUnixPhysicalFilename`	function	Resolves the symlink in Filename including omitted directories.
`InvalidateFileStateCache`	procedure	Signals the OnInvalidateFileStateCache event handler.
`IsCurrentPathDelim`	function	Determines if the current path delimiter matches the specified path delimiter notation.
`IsUNCPath`	function	Indicates if the specified path uses Universal Naming Convention (UNC).
`MergeCmdLineParams`	function	Generates a string with the specified list of parameters.
`MinimizeSearchPath`	function	Trims the specified path, and removes empty or duplicate paths.
`PathIsInPath`	function	Checks whether the specified directory exists in a given path.
`PrepareCmdLineOption`	function	Ensures command line options are properly quoted (when needed).
`ReadAllLinks`	function	Resolves a symbolic link to an actual file name.
`RemoveDirUTF8`	function	Removes the directory with the specified name.
`RenameFileUTF8`	function	Renames a file to the specified value.
`ResolveDots`	function	Resolves relative path references and removes duplicate path delimiters.
`SetCurrentDirUTF8`	function	Sets the current directory to the specified name.
`ShortDisplayFilename`	function	Gets a shortened version of the specified file name up to a maximum length.
`SplitCmdLine`	procedure	Splits the specified command line into program and parameter values.
`SplitCmdLineParams`	procedure	Splits command line parameters separated by whitespace characters into the specified TStrings instance.
`StrToCmdLineParam`	function	Ensures that whitespace and quoting in the specified string are valid for use in command line parameters.
`SwitchPathDelims`	function	Replaces path delimiters in a file path with the specified delimiter.
`TrimAndExpandDirectory`	function	Cleans and resolves a relative path to a base directory.
`TrimAndExpandFilename`	function	Cleans and resolves a file path to the specified base directory name.
`TrimFilename`	function	Removes leading and trailing spaces, and resolves special characters.
`TryCreateRelativePath`	function	Attempts to create a path in Dest relative to the path in Source.
`TryReadAllLinks`	function	Resolves a symlink to a real file name.
`UniversalFileAgeUtf8`	function	Gets the age for the specified file or directory name.

Types

`TInvalidateFileStateCacheEvent`	procedure type	Specifies the event signalled for an invalid file state in the file cache.
`TPathDelimSwitch`	enumeration	Represents the platform- or OS-specific path delimiters available in the Lazarus LCL.
`TPhysicalFilenameOnError`	enumeration	Enumerated type representing actions performed for an unresolved file name.

Constants

PathDelimSwitchToDelim constant Constant array with characters used as path delimiters for supported platforms and OS's.

Variables

OnInvalidateFileStateCache variable Implements the event handler for a file with an invalid file state.

Uses

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