Sign in Join
FPDoc Onlineexperiment

TSources.AddExampleFiles procedure

Member of TSourcespublicIn unit fpMkUnit

Adds example files matching file mask pattern

Declaration

pascal
procedure AddExampleFiles(const AFileMask: string; 
                         const ASearchPathPrefix: string; 
                         Recursive: Boolean=False; 
                         AInstallSourcePath: string='')

Arguments

AFileMask

File mask pattern for matching example files

ASearchPathPrefix

Path prefix for example file search operations

Recursive

Whether to search subdirectories recursively

AInstallSourcePath

Installation path for example source files

Description

AddExampleFiles adds example files to the source collection that match the specified file mask pattern. The method scans for files matching AFileMask and adds them to be included with the package as example code.

Example files are typically demonstration code showing how to use the package functionality. They are installed to the specified installation path for reference by package users.

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