Platforms to show: All Mac Windows Linux Cross-Platform

Back to ArchiveReaderMBS class.

Next items

ArchiveReaderMBS.AddPassphrase(passphrase as string)

Type Topic Plugin Version macOS Windows Linux iOS Targets
method Archive MBS Compression Plugin 19.0 ✅ Yes ✅ Yes ✅ Yes ✅ Yes All
Adds a password to the archive.

ArchiveReaderMBS.AppendFilter(Filter as Integer)

Type Topic Plugin Version macOS Windows Linux iOS Targets
method Archive MBS Compression Plugin 19.0 ✅ Yes ✅ Yes ✅ Yes ✅ Yes All
Adds a filter to the reader manually.

This is useful to bypass the bidding process when the format and filters to use is known in advance.
Lasterror property is set.

ArchiveReaderMBS.AppendFilterProgram(Program as String)

Type Topic Plugin Version macOS Windows Linux iOS Targets
method Archive MBS Compression Plugin 19.0 ✅ Yes ✅ Yes ✅ Yes ✅ Yes All
Adds a filter program.

Lasterror property is set.

ArchiveReaderMBS.Close

Type Topic Plugin Version macOS Windows Linux iOS Targets
method Archive MBS Compression Plugin 19.0 ✅ Yes ✅ Yes ✅ Yes ✅ Yes All
Close the file and release most resources.

Lasterror property is set.

ArchiveReaderMBS.Constructor

Type Topic Plugin Version macOS Windows Linux iOS Targets
method Archive MBS Compression Plugin 16.2 ✅ Yes ✅ Yes ✅ Yes ✅ Yes All
The constructor.
Example

dim a as new ArchiveReaderMBS
a.SupportFilterAll
a.SupportFormatAll
a.SetOptions "hdrcharset=UTF-8" // for unicode file names

To create an archive:
1) Ask Constructor for an archive writer object.
2) Set any global properties. In particular, you should set the compression and format to use.
3) Call one of the open methods to open the file (most people will use OpenFile, which provide convenient canned I/O callbacks for you).
4) For each entry, construct an appropriate ArchiveEntryMBS object, call WriteHeader to write the header, call WriteData methods to write the entry data.
5) call close method to close the output

ArchiveReaderMBS.Destructor

Type Topic Plugin Version macOS Windows Linux iOS Targets
method Archive MBS Compression Plugin 16.2 ✅ Yes ✅ Yes ✅ Yes ✅ Yes All
The destructor.

ArchiveReaderMBS.Extract(Entry as ArchiveEntryMBS, DestArchive as ArchiverMBS)

Type Topic Plugin Version macOS Windows Linux iOS Targets
method Archive MBS Compression Plugin 19.0 ✅ Yes ✅ Yes ✅ Yes ✅ Yes All
Convenience function to recreate the current entry (whose header has just been read) on disk.

This does quite a bit more than just copy data to disk. It also:

  • Creates intermediate directories as required.
  • Manages directory permissions: non-writable directories will be initially created with write permission enabled; when the archive is closed, dir permissions are edited to the values specified in the archive.
  • Checks hardlinks: hardlinks will not be extracted unless the linked-to file was also extracted within the same session. (TODO)

Lasterror property is set.

See also:

ArchiveReaderMBS.Extract(Entry as ArchiveEntryMBS, flags as Integer = &h123F7)

Type Topic Plugin Version macOS Windows Linux iOS Targets
method Archive MBS Compression Plugin 19.0 ✅ Yes ✅ Yes ✅ Yes ✅ Yes All
Convenience function to recreate the current entry (whose header has just been read) on disk.

This does quite a bit more than just copy data to disk. It also:

  • Creates intermediate directories as required.
  • Manages directory permissions: non-writable directories will be initially created with write permission enabled; when the archive is closed, dir permissions are edited to the values specified in the archive.
  • Checks hardlinks: hardlinks will not be extracted unless the linked-to file was also extracted within the same session. (TODO)

The "flags" argument selects optional behavior, 'OR' the flags you want.
Lasterror property is set.

See also:

ArchiveReaderMBS.NextHeader(entry as ArchiveEntryMBS = nil) as ArchiveEntryMBS

Type Topic Plugin Version macOS Windows Linux iOS Targets
method Archive MBS Compression Plugin 16.2 ✅ Yes ✅ Yes ✅ Yes ✅ Yes All
Reads next header.

If you pass in an existing entry, we can recycle the object.
Returns nil in case of error.
Lasterror property is set.

Some examples using this method:

ArchiveReaderMBS.OpenData(Data as String) as Boolean

Type Topic Plugin Version macOS Windows Linux iOS Targets
method Archive MBS Compression Plugin 16.2 ✅ Yes ✅ Yes ✅ Yes ✅ Yes All
Opens an archive from memory.

Returns true on success and false on failure.
Lasterror property is set.

ArchiveReaderMBS.OpenFile(File as FolderItem, BlockSize as Integer = 10240) as Boolean

Type Topic Plugin Version macOS Windows Linux iOS Targets
method Archive MBS Compression Plugin 16.2 ✅ Yes ✅ Yes ✅ Yes ✅ Yes All
Opens an archive from a folderitem.

Returns true on success and false on failure.
Lasterror property is set.

See also:

ArchiveReaderMBS.OpenFile(Files() as FolderItem, BlockSize as Integer = 10240) as Boolean

Type Topic Plugin Version macOS Windows Linux iOS Targets
method Archive MBS Compression Plugin 19.0 ✅ Yes ✅ Yes ✅ Yes ✅ Yes All
Use this for reading multivolume files by filenames.

Returns true on success and false on errors.
Lasterror property is set.

See also:

ArchiveReaderMBS.OpenPath(Path as String, BlockSize as Integer = 10240) as Boolean

Type Topic Plugin Version macOS Windows Linux iOS Targets
method Archive MBS Compression Plugin 19.0 ✅ Yes ✅ Yes ✅ Yes ✅ Yes All
Opens the file at the given path.

Lasterror property is set.

See also:

ArchiveReaderMBS.OpenPath(Paths() as String, BlockSize as Integer = 10240) as Boolean

Type Topic Plugin Version macOS Windows Linux iOS Targets
method Archive MBS Compression Plugin 19.0 ✅ Yes ✅ Yes ✅ Yes ✅ Yes All
Use this for reading multivolume files by filenames.

Returns true on success and false on errors.
Lasterror property is set.

See also:

ArchiveReaderMBS.ReadDataBlockMemory(byref offset as Int64) as MemoryBlock

Type Topic Plugin Version macOS Windows Linux iOS Targets
method Archive MBS Compression Plugin 19.0 ✅ Yes ✅ Yes ✅ Yes ✅ Yes All
Reads next block of data.

Size is given by archive reader used.
Offset is given so you know where you are in the file currently.
Data returned as new memory block.
Lasterror property is set.

A zero-copy version of archive_read_data that also exposes the file offset of each returned block. Note that the client has no way to specify the desired size of the block. The API does guarantee that offsets will be strictly increasing and that returned blocks will not overlap.

ArchiveReaderMBS.ReadDataBlockString(byref offset as Int64) as String

Type Topic Plugin Version macOS Windows Linux iOS Targets
method Archive MBS Compression Plugin 19.0 ✅ Yes ✅ Yes ✅ Yes ✅ Yes All
Reads next block of data.

Size is given by archive reader used.
Offset is given so you know where you are in the file currently.
Data returned as new string.
Lasterror property is set.

A zero-copy version of archive_read_data that also exposes the file offset of each returned block. Note that the client has no way to specify the desired size of the block. The API does guarantee that offsets will be strictly increasing and that returned blocks will not overlap.

ArchiveReaderMBS.ReadDataMemory(ByteCount as Integer) as MemoryBlock

Type Topic Plugin Version macOS Windows Linux iOS Targets
method Archive MBS Compression Plugin 16.2 ✅ Yes ✅ Yes ✅ Yes ✅ Yes All
Reads data from current file into memoryblock.

Lasterror property is set.

ArchiveReaderMBS.ReadDataString(ByteCount as Integer) as String

Type Topic Plugin Version macOS Windows Linux iOS Targets
method Archive MBS Compression Plugin 16.2 ✅ Yes ✅ Yes ✅ Yes ✅ Yes All
Reads data from current file into string.

Lasterror property is set.

Some examples using this method:

ArchiveReaderMBS.Seek(Position as Int64, Mode as Integer = 0) as Int64

Type Topic Plugin Version macOS Windows Linux iOS Targets
method Archive MBS Compression Plugin 19.0 ✅ Yes ✅ Yes ✅ Yes ✅ Yes All
Seek within the body of an entry.

See kSeekSet, kSeekCur or kSeekEnd constants.
Returns new position.
Lasterror property is set.

ArchiveReaderMBS.SetExtractSkipFile(DeviceID as Int64, FileNo as Int64)

Type Topic Plugin Version macOS Windows Linux iOS Targets
method Archive MBS Compression Plugin 19.0 ✅ Yes ✅ Yes ✅ Yes ✅ Yes All
Record the dev/ino of a file that will not be written.

This is generally set to the dev/ino of the archive being read.
Lasterror property is set.

ArchiveReaderMBS.SetFilterOption(Module as String, Option as String, Value as String)

Type Topic Plugin Version macOS Windows Linux iOS Targets
method Archive MBS Compression Plugin 19.0 ✅ Yes ✅ Yes ✅ Yes ✅ Yes All
Apply option to the filter only.

Lasterror property is set.

ArchiveReaderMBS.SetFormat(Format as Integer)

Type Topic Plugin Version macOS Windows Linux iOS Targets
method Archive MBS Compression Plugin 19.0 ✅ Yes ✅ Yes ✅ Yes ✅ Yes All
Sets the format for the reader manually.

This is useful to bypass the bidding process when the format and filters to use is known in advance.
Lasterror property is set.

ArchiveReaderMBS.SetFormatOption(Module as String, Option as String, Value as String)

Type Topic Plugin Version macOS Windows Linux iOS Targets
method Archive MBS Compression Plugin 19.0 ✅ Yes ✅ Yes ✅ Yes ✅ Yes All
Apply option to the format only.

Lasterror property is set.

ArchiveReaderMBS.SetOption(Module as String, Option as String, Value as String)

Type Topic Plugin Version macOS Windows Linux iOS Targets
method Archive MBS Compression Plugin 19.0 ✅ Yes ✅ Yes ✅ Yes ✅ Yes All
Apply option to both the format and the filter.

Lasterror property is set.

ArchiveReaderMBS.SetOptions(Options as String)

Type Topic Plugin Version macOS Windows Linux iOS Targets
method Archive MBS Compression Plugin 19.0 ✅ Yes ✅ Yes ✅ Yes ✅ Yes All
Apply option string to both the format and the filter.
Example

dim a as new ArchiveReaderMBS
a.SupportFilterAll
a.SupportFormatAll
a.SetOptions "hdrcharset=UTF-8" // for unicode file names

Lasterror property is set.

ArchiveReaderMBS.Skip

Type Topic Plugin Version macOS Windows Linux iOS Targets
method Archive MBS Compression Plugin 16.2 ✅ Yes ✅ Yes ✅ Yes ✅ Yes All
Skips a file in the archive.

ArchiveReaderMBS.SupportFilterAll

Type Topic Plugin Version macOS Windows Linux iOS Targets
method Archive MBS Compression Plugin 16.2 ✅ Yes ✅ Yes ✅ Yes ✅ Yes All
Enables all filters.

Lasterror property is set.

Some examples using this method:

ArchiveReaderMBS.SupportFilterBZip2

Type Topic Plugin Version macOS Windows Linux iOS Targets
method Archive MBS Compression Plugin 16.2 ✅ Yes ✅ Yes ✅ Yes ✅ Yes All
Enables bzip2 filter.

Lasterror property is set.

ArchiveReaderMBS.SupportFilterCompress

Type Topic Plugin Version macOS Windows Linux iOS Targets
method Archive MBS Compression Plugin 16.2 ✅ Yes ✅ Yes ✅ Yes ✅ Yes All
Enables compress filter.

Lasterror property is set.

ArchiveReaderMBS.SupportFilterGRZip

Type Topic Plugin Version macOS Windows Linux iOS Targets
method Archive MBS Compression Plugin 16.2 ✅ Yes ✅ Yes ✅ Yes ✅ Yes All
Enables GRZip filter.

Lasterror property is set.

ArchiveReaderMBS.SupportFilterGZip

Type Topic Plugin Version macOS Windows Linux iOS Targets
method Archive MBS Compression Plugin 16.2 ✅ Yes ✅ Yes ✅ Yes ✅ Yes All
Enable gzip filter.

Lasterror property is set.

ArchiveReaderMBS.SupportFilterLRZip

Type Topic Plugin Version macOS Windows Linux iOS Targets
method Archive MBS Compression Plugin 16.2 ✅ Yes ✅ Yes ✅ Yes ✅ Yes All
Enable LRZip filter.

Lasterror property is set.

ArchiveReaderMBS.SupportFilterLZip

Type Topic Plugin Version macOS Windows Linux iOS Targets
method Archive MBS Compression Plugin 16.2 ✅ Yes ✅ Yes ✅ Yes ✅ Yes All
Enable LZip filter.

Lasterror property is set.

ArchiveReaderMBS.SupportFilterLzma

Type Topic Plugin Version macOS Windows Linux iOS Targets
method Archive MBS Compression Plugin 16.2 ✅ Yes ✅ Yes ✅ Yes ✅ Yes All
Enable LZMA filter.

Lasterror property is set.

ArchiveReaderMBS.SupportFilterLzop

Type Topic Plugin Version macOS Windows Linux iOS Targets
method Archive MBS Compression Plugin 16.2 ✅ Yes ✅ Yes ✅ Yes ✅ Yes All
Enable Lzop filter.

Lasterror property is set.

ArchiveReaderMBS.SupportFilterNone

Type Topic Plugin Version macOS Windows Linux iOS Targets
method Archive MBS Compression Plugin 16.2 ✅ Yes ✅ Yes ✅ Yes ✅ Yes All
Enable none filter.

Lasterror property is set.

ArchiveReaderMBS.SupportFilterProgram(command as string)

Type Topic Plugin Version macOS Windows Linux iOS Targets
method Archive MBS Compression Plugin 19.0 ✅ Yes ✅ Yes ✅ Yes ✅ Yes All
Enable support for given filter program.

Lasterror property is set.

ArchiveReaderMBS.SupportFilterRpm

Type Topic Plugin Version macOS Windows Linux iOS Targets
method Archive MBS Compression Plugin 16.2 ✅ Yes ✅ Yes ✅ Yes ✅ Yes All
Enable RPM filter.

Lasterror property is set.

ArchiveReaderMBS.SupportFilterUU

Type Topic Plugin Version macOS Windows Linux iOS Targets
method Archive MBS Compression Plugin 16.2 ✅ Yes ✅ Yes ✅ Yes ✅ Yes All
Enable UU filter.

Lasterror property is set.

ArchiveReaderMBS.SupportFilterXz

Type Topic Plugin Version macOS Windows Linux iOS Targets
method Archive MBS Compression Plugin 16.2 ✅ Yes ✅ Yes ✅ Yes ✅ Yes All
Enable XZ filter.

xz is a lossless data compression program and file format which incorporates the LZMA/LZMA2 compression algorithms.

ArchiveReaderMBS.SupportFormat7zip

Type Topic Plugin Version macOS Windows Linux iOS Targets
method Archive MBS Compression Plugin 16.2 ✅ Yes ✅ Yes ✅ Yes ✅ Yes All
Enable 7zip format.

Lasterror property is set.

ArchiveReaderMBS.SupportFormatAll

Type Topic Plugin Version macOS Windows Linux iOS Targets
method Archive MBS Compression Plugin 16.2 ✅ Yes ✅ Yes ✅ Yes ✅ Yes All
Enable all formats.

Lasterror property is set.

Some examples using this method:

ArchiveReaderMBS.SupportFormatAr

Type Topic Plugin Version macOS Windows Linux iOS Targets
method Archive MBS Compression Plugin 16.2 ✅ Yes ✅ Yes ✅ Yes ✅ Yes All
Enables At format.

Lasterror property is set.

ArchiveReaderMBS.SupportFormatByCode(FilterCode as Integer)

Type Topic Plugin Version macOS Windows Linux iOS Targets
method Archive MBS Compression Plugin 16.2 ✅ Yes ✅ Yes ✅ Yes ✅ Yes All
Enables format with given code.

Lasterror property is set.

ArchiveReaderMBS.SupportFormatCab

Type Topic Plugin Version macOS Windows Linux iOS Targets
method Archive MBS Compression Plugin 16.2 ✅ Yes ✅ Yes ✅ Yes ✅ Yes All
Enables cab format.

Lasterror property is set.

ArchiveReaderMBS.SupportFormatCpio

Type Topic Plugin Version macOS Windows Linux iOS Targets
method Archive MBS Compression Plugin 16.2 ✅ Yes ✅ Yes ✅ Yes ✅ Yes All
Enables cpio format.

Lasterror property is set.

ArchiveReaderMBS.SupportFormatEmpty

Type Topic Plugin Version macOS Windows Linux iOS Targets
method Archive MBS Compression Plugin 16.2 ✅ Yes ✅ Yes ✅ Yes ✅ Yes All
Enables empty format.

Lasterror property is set.

ArchiveReaderMBS.SupportFormatGnutar

Type Topic Plugin Version macOS Windows Linux iOS Targets
method Archive MBS Compression Plugin 16.2 ✅ Yes ✅ Yes ✅ Yes ✅ Yes All
Enables gnutar format.

Lasterror property is set.

ArchiveReaderMBS.SupportFormatIso9660

Type Topic Plugin Version macOS Windows Linux iOS Targets
method Archive MBS Compression Plugin 16.2 ✅ Yes ✅ Yes ✅ Yes ✅ Yes All
Enables iso 9660 format.

Lasterror property is set.

Next items

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


The biggest plugin in space...