Platforms to show: All Mac Windows Linux Cross-Platform

Back to ArchiveReaderMBS class.

ArchiveReaderMBS.FormatCapabilities as Integer

Type Topic Plugin Version macOS Windows Linux iOS Targets
property Archive MBS Compression Plugin 16.3 ✅ Yes ✅ Yes ✅ Yes ✅ Yes All
Returns a bitmask of capabilities that are supported by the archive format reader.

If the reader has no special capabilities, kFormatCapabilitiesNone is returned.
See also kFormatCapabilitiesEncryptMetaData and kFormatCapabilitiesEncryptData.
(Read only property)

ArchiveReaderMBS.HasEncryptedEntries as Integer

Type Topic Plugin Version macOS Windows Linux iOS Targets
property Archive MBS Compression Plugin 16.3 ✅ Yes ✅ Yes ✅ Yes ✅ Yes All
Returns 1 if the archive contains at least one encrypted entry.

If the archive format not support encryption at all kEncryptionUnsupported is returned. If for any other reason (e.g. not enough data read so far) we cannot say whether there are encrypted entries, then kEncryptionDontKnow is returned. In general, this function will return values below zero when the reader is uncertain or totally uncapable of encryption support. When this function returns 0 you can be sure that the reader supports encryption detection but no encrypted entries have been found yet.

If the metadata/header of an archive is also encrypted, you cannot rely on the number of encrypted entries. That is why this function does not return the number of encrypted entries but# just shows that there are some.
(Read only property)

ArchiveReaderMBS.HeaderPosition as Int64

Type Topic Plugin Version macOS Windows Linux iOS Targets
property Archive MBS Compression Plugin 16.2 ✅ Yes ✅ Yes ✅ Yes ✅ Yes All
The current header position.

Retrieve the byte offset in uncompressed data where last-read header started.
(Read only property)

ArchiveReaderMBS.ReadDataBlockSupported as Boolean

Type Topic Plugin Version macOS Windows Linux iOS Targets
property Archive MBS Compression Plugin 19.0 ✅ Yes ✅ Yes ✅ Yes ✅ Yes All
Whether this reader supports block operations.

Some do and if you call ReadDataBlock on a reader which can't, it will return only errors.
(Read only property)

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


The biggest plugin in space...