Xojo Conferences
MBSOct2019CologneDE

Platforms to show: All Mac Windows Linux Cross-Platform

Next items

ArchiveReaderMBS.AddPassphrase(passphrase as string)
Type Topic Plugin Version macOS Windows Linux Console & Web iOS
method Archive MBS Compression Plugin 19.0 Yes Yes Yes Yes No
Function: Adds a password to the archive.

Feedback, Comments & Corrections

ArchiveReaderMBS.AppendFilter(Filter as Integer)
Type Topic Plugin Version macOS Windows Linux Console & Web iOS
method Archive MBS Compression Plugin 19.0 Yes Yes Yes Yes No
Function: Adds a filter to the reader manually.
Notes:
This is useful to bypass the bidding process when the format and filters to use is known in advance.
Lasterror property is set.

Feedback, Comments & Corrections

ArchiveReaderMBS.AppendFilterProgram(Program as String)
Type Topic Plugin Version macOS Windows Linux Console & Web iOS
method Archive MBS Compression Plugin 19.0 Yes Yes Yes Yes No
Function: Adds a filter program.
Notes: Lasterror property is set.

Feedback, Comments & Corrections

ArchiveReaderMBS.Close
Type Topic Plugin Version macOS Windows Linux Console & Web iOS
method Archive MBS Compression Plugin 19.0 Yes Yes Yes Yes No
Function: Close the file and release most resources.
Notes: Lasterror property is set.

Feedback, Comments & Corrections

ArchiveReaderMBS.Constructor
Type Topic Plugin Version macOS Windows Linux Console & Web iOS
method Archive MBS Compression Plugin 16.2 Yes Yes Yes Yes No
Function: The constructor.
Notes:
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

Feedback, Comments & Corrections

ArchiveReaderMBS.Destructor
Type Topic Plugin Version macOS Windows Linux Console & Web iOS
method Archive MBS Compression Plugin 16.2 Yes Yes Yes Yes No
Function: The destructor.

Feedback, Comments & Corrections

ArchiveReaderMBS.Extract(Entry as ArchiveEntryMBS, DestArchive as ArchiverMBS)
Type Topic Plugin Version macOS Windows Linux Console & Web iOS
method Archive MBS Compression Plugin 19.0 Yes Yes Yes Yes No
Function: Convenience function to recreate the current entry (whose header has just been read) on disk.
Notes:
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:

Feedback, Comments & Corrections

ArchiveReaderMBS.Extract(Entry as ArchiveEntryMBS, flags as Integer = &h123F7)
Type Topic Plugin Version macOS Windows Linux Console & Web iOS
method Archive MBS Compression Plugin 19.0 Yes Yes Yes Yes No
Function: Convenience function to recreate the current entry (whose header has just been read) on disk.
Notes:
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:

Feedback, Comments & Corrections

ArchiveReaderMBS.NextHeader(entry as ArchiveEntryMBS = nil) as ArchiveEntryMBS
Type Topic Plugin Version macOS Windows Linux Console & Web iOS
method Archive MBS Compression Plugin 16.2 Yes Yes Yes Yes No
Function: Reads next header.
Notes:
If you pass in an existing entry, we can recycle the object.
Returns nil in case of error.
Lasterror property is set.

Feedback, Comments & Corrections

ArchiveReaderMBS.OpenData(Data as String) as Boolean
Type Topic Plugin Version macOS Windows Linux Console & Web iOS
method Archive MBS Compression Plugin 16.2 Yes Yes Yes Yes No
Function: Opens an archive from memory.
Notes:
Returns true on success and false on failure.
Lasterror property is set.

Feedback, Comments & Corrections

ArchiveReaderMBS.OpenFile(File as FolderItem, BlockSize as Integer = 10240) as Boolean
Type Topic Plugin Version macOS Windows Linux Console & Web iOS
method Archive MBS Compression Plugin 16.2 Yes Yes Yes Yes No
Function: Opens an archive from a folderitem.
Notes:
Returns true on success and false on failure.
Lasterror property is set.

See also:

Feedback, Comments & Corrections

ArchiveReaderMBS.OpenFile(Files() as FolderItem, BlockSize as Integer = 10240) as Boolean
Type Topic Plugin Version macOS Windows Linux Console & Web iOS
method Archive MBS Compression Plugin 19.0 Yes Yes Yes Yes No
Function: Use this for reading multivolume files by filenames.
Notes:
Returns true on success and false on errors.
Lasterror property is set.

See also:

Feedback, Comments & Corrections

ArchiveReaderMBS.OpenPath(Path as String, BlockSize as Integer = 10240) as Boolean
Type Topic Plugin Version macOS Windows Linux Console & Web iOS
method Archive MBS Compression Plugin 19.0 Yes Yes Yes Yes No
Function: Opens the file at the given path.
Notes: Lasterror property is set.

See also:

Feedback, Comments & Corrections

ArchiveReaderMBS.OpenPath(Paths() as String, BlockSize as Integer = 10240) as Boolean
Type Topic Plugin Version macOS Windows Linux Console & Web iOS
method Archive MBS Compression Plugin 19.0 Yes Yes Yes Yes No
Function: Use this for reading multivolume files by filenames.
Notes:
Returns true on success and false on errors.
Lasterror property is set.

See also:

Feedback, Comments & Corrections

ArchiveReaderMBS.ReadDataBlockMemory(byref offset as Int64) as MemoryBlock
Type Topic Plugin Version macOS Windows Linux Console & Web iOS
method Archive MBS Compression Plugin 19.0 Yes Yes Yes Yes No
Function: Reads next block of data.
Notes:
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.

Feedback, Comments & Corrections

ArchiveReaderMBS.ReadDataBlockString(byref offset as Int64) as String
Type Topic Plugin Version macOS Windows Linux Console & Web iOS
method Archive MBS Compression Plugin 19.0 Yes Yes Yes Yes No
Function: Reads next block of data.
Notes:
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.

Feedback, Comments & Corrections

ArchiveReaderMBS.ReadDataMemory(ByteCount as Integer) as MemoryBlock
Type Topic Plugin Version macOS Windows Linux Console & Web iOS
method Archive MBS Compression Plugin 16.2 Yes Yes Yes Yes No
Function: Reads data from current file into memoryblock.
Notes: Lasterror property is set.

Feedback, Comments & Corrections

ArchiveReaderMBS.ReadDataString(ByteCount as Integer) as String
Type Topic Plugin Version macOS Windows Linux Console & Web iOS
method Archive MBS Compression Plugin 16.2 Yes Yes Yes Yes No
Function: Reads data from current file into string.
Notes: Lasterror property is set.

Feedback, Comments & Corrections

ArchiveReaderMBS.Seek(Position as Int64, Mode as Integer = 0) as Int64
Type Topic Plugin Version macOS Windows Linux Console & Web iOS
method Archive MBS Compression Plugin 19.0 Yes Yes Yes Yes No
Function: Seek within the body of an entry.
Notes:
See kSeekSet, kSeekCur or kSeekEnd constants.
Returns new position.
Lasterror property is set.

Feedback, Comments & Corrections

ArchiveReaderMBS.SetExtractSkipFile(DeviceID as Int64, FileNo as Int64)
Type Topic Plugin Version macOS Windows Linux Console & Web iOS
method Archive MBS Compression Plugin 19.0 Yes Yes Yes Yes No
Function: Record the dev/ino of a file that will not be written.
Notes:
This is generally set to the dev/ino of the archive being read.
Lasterror property is set.

Feedback, Comments & Corrections

ArchiveReaderMBS.SetFilterOption(Module as String, Option as String, Value as String)
Type Topic Plugin Version macOS Windows Linux Console & Web iOS
method Archive MBS Compression Plugin 19.0 Yes Yes Yes Yes No
Function: Apply option to the filter only.
Notes: Lasterror property is set.

Feedback, Comments & Corrections

ArchiveReaderMBS.SetFormat(Format as Integer)
Type Topic Plugin Version macOS Windows Linux Console & Web iOS
method Archive MBS Compression Plugin 19.0 Yes Yes Yes Yes No
Function: Sets the format for the reader manually.
Notes:
This is useful to bypass the bidding process when the format and filters to use is known in advance.
Lasterror property is set.

Feedback, Comments & Corrections

ArchiveReaderMBS.SetFormatOption(Module as String, Option as String, Value as String)
Type Topic Plugin Version macOS Windows Linux Console & Web iOS
method Archive MBS Compression Plugin 19.0 Yes Yes Yes Yes No
Function: Apply option to the format only.
Notes: Lasterror property is set.

Feedback, Comments & Corrections

ArchiveReaderMBS.SetOption(Module as String, Option as String, Value as String)
Type Topic Plugin Version macOS Windows Linux Console & Web iOS
method Archive MBS Compression Plugin 19.0 Yes Yes Yes Yes No
Function: Apply option to both the format and the filter.
Notes: Lasterror property is set.

Feedback, Comments & Corrections

ArchiveReaderMBS.SetOptions(Options as String)
Type Topic Plugin Version macOS Windows Linux Console & Web iOS
method Archive MBS Compression Plugin 19.0 Yes Yes Yes Yes No
Function: Apply option string to both the format and the filter.
Notes: Lasterror property is set.

Feedback, Comments & Corrections

ArchiveReaderMBS.Skip
Type Topic Plugin Version macOS Windows Linux Console & Web iOS
method Archive MBS Compression Plugin 16.2 Yes Yes Yes Yes No
Function: Skips a file in the archive.

Feedback, Comments & Corrections

ArchiveReaderMBS.SupportFilterAll
Type Topic Plugin Version macOS Windows Linux Console & Web iOS
method Archive MBS Compression Plugin 16.2 Yes Yes Yes Yes No
Function: Enables all filters.
Notes: Lasterror property is set.

Feedback, Comments & Corrections

ArchiveReaderMBS.SupportFilterBZip2
Type Topic Plugin Version macOS Windows Linux Console & Web iOS
method Archive MBS Compression Plugin 16.2 Yes Yes Yes Yes No
Function: Enables bzip2 filter.
Notes: Lasterror property is set.

Feedback, Comments & Corrections

ArchiveReaderMBS.SupportFilterCompress
Type Topic Plugin Version macOS Windows Linux Console & Web iOS
method Archive MBS Compression Plugin 16.2 Yes Yes Yes Yes No
Function: Enables compress filter.
Notes: Lasterror property is set.

Feedback, Comments & Corrections

Next items

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

The biggest plugin in space...




Links
MBS FileMaker Plugins