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

ReadAllLinks

Resolves a symbolic link to an actual file name.

Declaration

Source position: lazfileutils.pas line 137

function ReadAllLinks(

  const Filename: string;

  ExceptionOnError: Boolean

):string;

Arguments

Filename

  

Symbolic link resolved in the routine.

ExceptionOnError

  

True to raise an exception for unresolved links. False to handle the exception internally and return the error message.

Function result

Resolved path to the specified file name, or an exception message when link(s) could not be resolved.

Description

ReadAllLinks is a String function used to resolve a symbolic link to an actual file name. It does not resolve symbolic links in parent (or ancestor) directories.

If a symlink cannot be resolved, and ExceptionOnError is False, the function returns an empty string (''). If ExceptionOnError is True, it raises an EFOpenError with a message containing more details. For the Windows platform, it simply returns the value in the Filename argument.


Version 3.2 Generated 2024-02-25 Home