[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

  

Checks whether the specified file name is a symbolic link on the local file system.

CheckPathDelim

  

Determines if the specified path delimiter character is not used on the system.

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 resolves special characters in the specified file name.

CompareFileExt

  

Compares the extension in a file name to a given value and returns the relative order.

CompareFilenames

  

Gets the relative sort order for the specified file names.

CompareFilenamesIgnoreCase

  

Gets the relative sort order for case-insensitive file names.

CompareFilenamesP

  

Compares file names to determine their relative sort order.

CompareFilenameStarts

  

Compares file names using the number characters in common.

CreateAbsolutePath

  

Returns an absolute path relative to the specified base directory (when needed).

CreateAbsoluteSearchPath

  

Concatenates BaseDirectory and SearchPath to form an absolute path to search for files.

CreateDirUTF8

  

Creates a new directory with the specified name.

CreateRelativePath

  

Gets the relative path from BaseDirectory to Filename.

CreateRelativeSearchPath

  

Resolves relative path value(s) in the specified search path.

DbgSFileAttr

  

Generates a debugger message with information about the specified file attributes.

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 on the local 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

  

Gets the value from AFilename prior to the '.' character that starts the file extension.

ExtractFileRoot

  

Gets the root drive/path/directory for the specified file name.

ExtractUNCVolume

  

Gets UNC host and volume name used in the specified path.

FileAgeUTF8

  

Returns the last modification time for the file in FileDate format.

FileCreateUTF8

  

Creates the specified file and returns its file handle.

FileExistsUTF8

  

Indicates if the specified UTF-8-encoded file name exists.

FileGetAttrUTF8

  

Gets the value of file attributes for the specified file name.

FileIsExecutable

  

Determines if the specified file name is executable.

FileIsHardLink

  

Indicates if the specified file has a descriptor or handle on the local file system.

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

  

Indicates if the specified file is a symbolic link in the file system.

FileIsText

  

Determines if the specified file contains plain text content.

FileIsWritable

  

Indicates if the specified file name is writable.

FilenameExtIn

  

Determines if the file name uses one of the specified file extensions.

FilenameExtIs

  

Determines if Filename has the specified file extension.

FilenameIsAbsolute

  

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

FilenameIsTrimmed

  

True if the specified file name contains characters to remove or resolve before use.

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

  

Opens the specified file name and returns its file handle.

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

  

Gets the size for the specified file name.

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

  

Locates the specified path in a delimited list of search paths.

ForceDirectoriesUTF8

  

Creates the directories specified in Dir if they do not already exist.

ForceDirectory

  

Creates the specified directory if it does not already exist.

ForcePathDelims

  

Ensures that path delimiters in the specified file name are correct for the current platform or OS.

GetAppConfigDirUTF8

  

Gets the directory for application configuration and data files.

GetAppConfigFileUTF8

  

Gets a UTF-8-encoded configuration file name for the current application.

GetCurrentDirUTF8

  

Gets the name for the current directory.

GetFileDescription

  

Gets descriptive information for the specified file name.

GetForcedPathDelims

  

Performs path delimiter substitutions for the specified file name.

GetPhysicalFilename

  

Gets the physical file name for a symbolic link on the local file system.

GetShellLinkTarget

  

Resolves a Shell Link to the file path for the shortcut.

GetTempFileNameUTF8

  

Gets a temporary file name using the specified UTF-8-encoded path and prefix.

InvalidateFileStateCache

  

Signals the OnInvalidateFileStateCache event handler.

IsCurrentPathDelim

  

Determines if the current path delimiter matches the specified path delimiter notation.

IsUNCPath

  

Indicates if the specified path uses Universal Naming Convention (UNC).

MergeCmdLineParams

  

Generates a string with the specified list of parameters.

MinimizeSearchPath

  

Trims the specified path, and removes empty or duplicate paths.

PathIsInPath

  

Checks whether the specified directory exists in a given path.

PrepareCmdLineOption

  

Ensures command line options are properly quoted (when needed).

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

  

Resolves relative path references and removes duplicate path delimiters.

SetCurrentDirUTF8

  

Sets the current directory to the specified name.

ShortDisplayFilename

  

Gets a shortened version of the specified file name up to a maximum length.

SplitCmdLine

  

Splits the specified command line into program and parameter values.

SplitCmdLineParams

  

Splits command line parameters separated by whitespace characters into the specified TStrings instance.

StrToCmdLineParam

  

Ensures that whitespace and quoting in the specified string are valid for use in command line parameters.

SwitchPathDelims

  

Replaces path delimiters in a file path with the specified delimiter.

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

  

Attempts to create a path in Dest relative to the path in Source.

TryReadAllLinks

  

Resolves a symlink to the real file.


Version 3.2 Generated 2024-02-25 Home