FileIsSymlink

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

Declaration

Source position: lazfileutils.pas line 52

Arguments

Function result

True when the specified file name is a symbolic link.

Description

FileIsSymlink is a Boolean function used to determine if the specified file name is a symbolic link on the local file system.

The implementation of FileIsSymlink is platform-specific. For UNIX-like environments, the FpReadLink function is used to determine if the symbolic link can be resolved to a physical file name in the local file system. For the Windows platform, FileGetAttrUTF8 is called to get and examine the file attributes for the specified file name. The file attributes must include the value FILE_ATTRIBUTE_REPARSE_POINT, and one of the Windows API values such as IO_REPARSE_TAG_SYMLINK or IO_REPARSE_TAG_MOUNT_POINT for the corresponding file handle. For the Amiga platform, FileIsSymLink always returns False.

See also