Sign in Join
FPDoc Onlineexperiment

TFileSearcher.FollowSymLink property

Member of TFileSearcherpublicIn unit FileUtil

Indicates if a search process directory paths that are symbolic links.

Declaration

pascal
property FollowSymLink: Boolean read FFollowSymLink write FFollowSymLink;

Description

FollowSymLink is a Boolean property which indicates if the Search method should process directory paths that are symbolic links on the local file system. The default value for the property is True as assigned in the Create method.

FollowSymLink is used in the Search method when a directory entry is detected in FileInfo that FileIsSymLink identifies as a symbolic link. When set to False, the directory is not processed; the OnDirectoryEnter event handler is not signalled and the method ignores the directory path. The OnDirectoryFound event handler is signalled for the iterator value.

Use CircularLinkDetection to control whether symbolic links in already processed directories are included in the search results.

See also

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