Sign in Join
FPDoc Onlineexperiment

GetPhysicalFilenameCached function

In unit LazFileCache

Gets the physical file name for the specified file or directory name.

Declaration

pascal
function GetPhysicalFilenameCached(const AFilename: string; 
 EmptyOnError: Boolean): string

Arguments

AFilename

File name resolved in the routine.

EmptyOnErrorTrue to return an empty string if AFilename is not found.

Function result

Actual file name for the symbolic link or reference.

Description

GetPhysicalFilenameCached is a String function used to get the physical file name for the value specified in AFileName. The return value contains the actual file name for a symbolic link or reference on the local file system.

EmptyOnError indicates that the return value can be an empty string ( '') if AFilename cannot be resolved. When set to False, the original file in AFileName is used as the return value.

GetPhysicalFilenameCached provides two (2) ways to resolve the value in AFilename:

  • Calling the GetPhysicalFilenameCached method in the FileStateCache singleton (when assigned). This is the default code path in the routine.
  • Calling the GetPhysicalFilename routine.

See also

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