TZipFileEntries.AddFileEntry function

Member of TZipFileEntriespublicIn unit Zipper

Adds file to zip directory.

Declaration

pascal

function AddFileEntry(const ADiskFileName: AnsiString): TZipFileEntry
function AddFileEntry(const ADiskFileName: AnsiString; 
 const AArchiveFileName: AnsiString): TZipFileEntry
function AddFileEntry(const AStream: TSTream; 
 const AArchiveFileName: AnsiString): TZipFileEntry

Arguments

`ADiskFileName`	Name of the file or directory on the local file system.
`AArchiveFileName`	Name used for the file or directory in the .ZIP archive.
`AStream`	Stream with the content for the zip file entry.

Function result

Collection item added in the method.

Description

AddFileEntry adds a file or directory to the list of entries that will be written out in the .zip file. AddFileEntry calls the Add method to create the new collection item, and casts it the TZipFileEntry type used in TZipFileEntries.

Values passed as arguments to the overloaded variants are stored in the corresponding properties in the TZipFileEntry instance.

The return value is the TZipFileEntry instance added to the collection.

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