ArchiveReaderMBS.AddPassphrase(passphrase as string)

ArchiveReaderMBS.AppendFilter(Filter as Integer)

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)

Lasterror property is set.

ArchiveReaderMBS.Close

Lasterror property is set.

ArchiveReaderMBS.Constructor

Var 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

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

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)

See also:

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

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

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)

See also:

• Extract(Entry as ArchiveEntryMBS, DestArchive as ArchiverMBS)

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

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:

• /Compression/Archive/archive
• /Compression/Archive/CreateArchive iOS
• /Compression/Archive/Extract files in Archive
• /Compression/Archive/List Files in Archive
• /Compression/Archive/untar
• /Compression/Archive/untar with extract

ArchiveReaderMBS.OpenData(Data as String) as Boolean

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

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

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

See also:

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

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

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

See also:

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

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

Lasterror property is set.

See also:

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

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

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

See also:

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

ArchiveReaderMBS.ReadDataBlockMemory(byref offset as Int64) as MemoryBlock

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

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

Lasterror property is set.

ArchiveReaderMBS.ReadDataString(ByteCount as Integer) as String

Lasterror property is set.

Some examples using this method:

• /Compression/Archive/Extract files in Archive