FindOnClick > FindOnClick For Advanced Users > Scripting > Functions

procedure AbortSearch;

Call this procedure to abort the search. This can be called at any point in the script. However, FindOnClick may not be able to abort immediately.

function SS_SearchPaths;

Return value: The total number of paths being searched. Get the path using SS_SearchPath.

function SS_SearchPath(Index);

Index: The search path to retrieve, with the first being zero (0). Use SS_SearchPaths to get the total number of paths.

Return value: The search path.

function SS_SearchPathsAreRegEx;

Return value: TRUE if the search paths are regular expressions.

function SS_RegExDrives;

Return value: If the search paths are regular expressions, then this returns the drives that are to be searched, e.g. 'CDF' means the drives C:, D: and F: are going to be searched. If empty, then all drives are searched (which includes A: and B: if SS_DrivesAB is TRUE).

function SS_FilenameFilters;

Return value: The total number of filenames filters. Get the filters using SS_FilenameFilter.

function SS_FilenameFilter(Index);

Index: The filename filter to retrieve, with the first being zero (0). Use SS_FilenameFilters to get the total number of filters.

Return value: The filename filter.

function SS_PathFilters;

Return value: The total number of path filters. Get the filters using SS_PathFilter.

function SS_PathFilter(Index);

Index: The path filter to retrieve, with the first being zero (0). Use SS_PathFilters to get the total number of filters.

Return value: The path filter.

function SS_SlowSearch;

Return value: Returns TRUE if a slow search is being performed.

function SS_DrivesAB;

Return value: Returns TRUE if drives A: and B: are to be included in the drives list. This is only relevant if SS_RegExDrives is empty and regular expression searching is being used.

function SS_HaveMinSize;

Return value: Returns TRUE if files must have a minimum size.

function SS_MinSize;

Return value: Returns the minimum size of a file to include. Ignore this value unless SS_HaveMinSize is TRUE.

function SS_HaveMaxSize;

Return value: Returns TRUE if files must have a maximum size

function SS_MaxSize;

Return value: Returns the maximum size of a file to include. Ignore this value unless SS_HaveMaxSize is TRUE.

function SS_HaveMinModDate;

Return value: Returns TRUE if files must have a minimum last modification date & time.

function SS_MinModDate;

Return value: Returns the minimum last modification date & time of a file to include. Ignore this value unless SS_HaveMinModDate is TRUE.

function SS_HaveMaxModDate;

Return value: Returns TRUE if files must have a maximum last modification date & time

function SS_MaxModDate;

Return value: Returns the maximum last modification date & time of a file to include. Ignore this value unless SS_HaveMaxModDate is TRUE.

function SS_HaveMinCreateDate;

Return value: Returns TRUE if files must have a minimum creation date & time.

function SS_MinCreateDate;

Return value: Returns the minimum creation date & time of a file to include. Ignore this value unless SS_HaveMinCreateDate is TRUE.

function SS_HaveMaxCreateDate;

Return value: Returns TRUE if files must have a maximum creation date & time

function SS_MaxCreateDate;

Return value: Returns the maximum creation date & time of a file to include. Ignore this value unless SS_HaveMaxCreateDate is TRUE.

function SS_IncludeExtensions;

Return value: The total number of filename extensions being included in the search results. Get the path using SS_IncludeExtension.

function SS_IncludeExtension(Index);

Index: The filename extensions to retrieve, with the first being zero (0). Use SS_IncludeExtensions to get the total number of filename extensions.

Return value: The filename extension.

function SS_ExcludeExtensions;

Return value: The total number of filename extensions being excluded from the search results. Get the path using SS_ExcludeExtension.

function SS_ExcludeExtension(Index);

Index: The filename extensions to retrieve, with the first being zero (0). Use SS_ExcludeExtensions to get the total number of filename extensions.

Return value: The filename extension.

function SS_HashType;

Return value: The type of hashing being used, e.g. EHT_MD5.

function SS_DuplicatesOnly;

Return value: TRUE if only duplicate files are being displayed.

function SS_Attrs;

Return value: The file attributes being filtered See SS_AttrsChoice to see how this value is being used.

function SS_AttrsChoice;

Return value: How the file attributes (see SS_Attrs) are being filtered, e.g. EAttrs_Exact

function SS_SearchString;

Return value: If the contents of files are being searched then this is the string being searched for.

function SS_SearchStringIsRegEx;

Return value: TRUE if SS_SearchString is a regular expression.

function SS_SearchStringDeepSearch;

Return value: TRUE if a deep search (using SS_SearchString) is being performed.

function SS_SearchStringCaseSensitive;

Return value: TRUE if SS_SearchString is case sensitive.

function SS_GetVersion;

Return value: TRUE if file version numbers are being retrieved.

function SS_GetMP3;

Return value: TRUE if MP3 data is being retrieved.

function SS_IgnoreFolders;

Return value: TRUE if folders are being ignored.

function SS_IgnoreFiles;

Return value: TRUE if files are being ignored.

Search Settings

Search Settings