Xojo Conferences

Platforms to show: All Mac Windows Linux Cross-Platform

ArchiveReadDiskMBS class

Super class: ArchiveReaderMBS

Type Topic Plugin Version macOS Windows Linux Console & Web iOS
class Archive MBS Compression Plugin 19.0 Yes Yes Yes Yes No
Function: The archive subclass class for reading files from disk.
Notes: Subclass of the ArchiveReaderMBS class.

Feedback, Comments & Corrections

Behavior Flags

Constant Value Description
kBehaviorRestoreAccessTime 1 Request that the access time of the entry visited by traversal be restored.
This is the same as SetAccessTimeRestored.
kBehaviorRestoreHonorNoDump 2 Default: Do not skip an entry which has nodump flags.
kBehaviorRestoreMacCopyFile 4 Default: Skip a mac resource fork file whose prefix is "._" because of using copyfile.
kBehaviorRestoreNoACL 32 Default: ACLs are read from disk.
kBehaviorRestoreNoFFlags 64 Default: File flags are read from disk.
kBehaviorRestoreNoTraverseMounts 8 Default: Traverse mount points.
kBehaviorRestoreNoXAttr 16 Default: Xattrs are read from disk.

Super class ArchiveReaderMBS

Encryption Status constants.

Constant Value Description
kEncryptionDontKnow -1 If the reader for some other reason (e.g. not enough bytes read) cannot say if there are encrypted entries, kEncryptionDontKnow is returned.
kEncryptionUnsupported -2 In case the archive does not support encryption detection at all kEncryptionUnsupported is returned.

Extract Flags

Constant Value Description
kExtractACL &h20 Default: Do not restore ACLs.
kExtractClearNoChangeFFlags &h20000 Default: Do not clear no-change flags when unlinking object.
kExtractFileFlags &h40 Default: Do not restore fflags.
kExtractHFSCompressionForced &h8000 Default: Do not use HFS+ compression if it was not compressed.
This has no effect except on Mac OS v10.6 or later.
kExtractMacMetadata &h2000 Default: Do not restore Mac extended metadata.
This has no effect except on Mac OS.
kExtractNoAutoDir &h400 Default: Create parent directories as needed.
kExtractNoHFSCompression &h4000 Default: Use HFS+ compression if it was compressed.
This has no effect except on Mac OS v10.6 or later.
kExtractNoOverwrite 8 Default: Replace existing files.
kExtractNoOverwriteNewer &h800 Default: Overwrite files, even if one on disk is newer.
kExtractOwner 1 Default: Do not try to set owner/group.
kExtractPermission 2 Default: Do obey umask, do not restore SUID/SGID/SVTX bits.
kExtractSecureNoAbsolutePath &h10000 Default: Do not reject entries with absolute paths
kExtractSecureNoDotDot &h200 Default: Do not reject entries with '..' as path elements.
kExtractSecureSymLinks &h100 Default: Do not try to guard against extracts redirected by symlinks.
Note: With kExtractUnlink, will remove any intermediate symlink.
kExtractSparse &h1000 Detect blocks of 0 and write holes instead.
kExtractTime 4 Default: Do not restore mtime/atime.
kExtractUnlink &h10 Default: Try create first, unlink only if create fails with EEXIST.
kExtractXAttr &h80 Default: Do not restore xattrs.

Encryption Capabilities

Constant Value Description
kFormatCapabilitiesEncryptData 1 Reader can detect encrypted data.
kFormatCapabilitiesEncryptMetaData 2 Reader can detect encryptable metadata (pathname, mtime, etc.).
kFormatCapabilitiesNone 0 Current format supports no encryption.

Seek Modes

Constant Value Description
kSeekCur 1 Seek relative to current position.
kSeekEnd 2 Seek relative to end of file.
kSeekSet 0 Seek relative to begin of file.

Super class ArchiverMBS

This class has no sub classes.

Some examples which use this class:

Blog Entries

The items on this page are in the following plugins: MBS Compression Plugin.

ArchiveEntryMBS   -   ArchiveReaderMBS

MBS Xojo Plugins