Sign in Join
FPDoc Onlineexperiment

TZipFileEntry class

In unit Zipper

Represents a file or directory added to a .ZIP file.

Declaration

pascal
TZipFileEntry = class(TCollectionItem)

Inheritance

  1. TZipFileEntry
  2. TCollectionItem
  3. TPersistent
  4. TObject

Descends from it: TFullZipFileEntry

Description

TZipFileEntry is a TCollectionItem descendant which represents a file or directory added to a .ZIP file archive. TZipFileEntry is the type used for items in the Entries property in the TZipFileEntries collection.

TZipFileEntry provides properties with metadata for the file or directory, including:

ArchiveFileName
Name of the file or directory in the .ZIP archive.
UTF8ArchiveFileName
Name of the file or directory in the .ZIP archive using UTF-8 encoding.
DiskFileName
Name of the file or directory on the local file system.
UTF8DiskFileName
Name of the file or directory using UTF-8 encoding.
Size
Size of the compressed file or directory in the .ZIP archive.
DateTime
The timestamp for file or directory in the .ZIP archive.
OS
Indicates the operating system device type / file system where the file or directory originated.
Attributes
File attributes for the entry.
CompressionLevel
Compression level applied to the content in the .ZIP archive.
Stream
TStream instance with the content for the entry.

Use IsDirectory to determine if the entry represents a directory.

Use IsLink to determine if the entry is a symbolic link on the local file system.

Properties

HdrPosprotected
NeedsZip64protected
StreampublicStream with the content for the entry.
ArchiveFileNamepublishedName of the file or directory in the .ZIP archive.
UTF8ArchiveFileNamepublishedArchive filename as UTF8 string.
DiskFileNamepublishedName of the file or directory on the local file system.
UTF8DiskFileNamepublishedName of the file or directory on the local file system using UTF-8 encoding.
SizepublishedSize of the compressed content for the file or directory.
DateTimepublishedTimestamp for the file or directory in the .ZIP archive.
OSpublishedIndication of operating system/file system.
AttributespublishedFile attributes for the file or directory.
CompressionLevelpublishedCompression level applied to the content stored in the .ZIP archive.

Methods

CreatepublicConstructor for the class instance.
IsDirectorypublicTrue if the entry is a directory on the local file system.
IsLinkpublicTrue if the directory is a symbolic link on the local file system.
AssignpublicCopies property values from the specified persistent object.

Inherited

From TCollectionItem (12)

Changed Collection Destroy DisplayName GetDisplayName GetNamePath GetOwner ID Index SetCollection SetDisplayName SetIndex

From TPersistent (5)

AssignTo DefineProperties FPOAttachObserver FPODetachObserver FPONotifyObservers

From TObject (40)

AfterConstruction BeforeDestruction CheckDisposed ClassInfo ClassName ClassNameIs ClassParent ClassType CleanupInstance DefaultHandler DefaultHandlerStr Dispatch DispatchStr Disposed DisposeOf Equals FieldAddress Free FreeInstance GetDisposed GetHashCode GetInterface GetInterfaceByStr GetInterfaceEntry GetInterfaceEntryByStr GetInterfaceTable GetInterfaceWeak GetLastCastErrorInfo InheritsFrom InitInstance InstanceSize MethodAddress MethodName newinstance QualifiedClassName SafeCallException StringMessageTable SystemHasExtendedRTTI ToString UnitName

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