Platforms to show: All Mac Windows Linux Cross-Platform
Back to BZip2CompressMBS class.
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
method | Compression | MBS Compression Plugin | 9.7 | ✅ Yes | ✅ Yes | ✅ Yes | ✅ Yes | All |
There is no need to call this method except you want to free all resources of this object now without waiting for Xojo to do it for you.
BZip2CompressMBS.Constructor(BufferSize as Integer=20000)
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
method | Compression | MBS Compression Plugin | 9.7 | ✅ Yes | ✅ Yes | ✅ Yes | ✅ Yes | All |
The buffer size you specify is the output buffer size.
If this size is small, you need to flush with ProcessZip.
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
method | Compression | MBS Compression Plugin | 9.7 | ✅ Yes | ✅ Yes | ✅ Yes | ✅ Yes | All |
You may check the Output property after this.
Error is set.
BZip2CompressMBS.GetOutput as string
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
method | Compression | MBS Compression Plugin | 9.7 | ✅ Yes | ✅ Yes | ✅ Yes | ✅ Yes | All |
The buffer is cleared after this function returns.
BZip2CompressMBS.InitZip(level as Integer)
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
method | Compression | MBS Compression Plugin | 9.7 | ✅ Yes | ✅ Yes | ✅ Yes | ✅ Yes | All |
Level is from 0 to 9.
Error is set.
BZip2CompressMBS.InputAvail as Integer
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
method | Compression | MBS Compression Plugin | 9.7 | ✅ Yes | ✅ Yes | ✅ Yes | ✅ Yes | All |
BZip2CompressMBS.OutputSize as Integer
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
method | Compression | MBS Compression Plugin | 9.7 | ✅ Yes | ✅ Yes | ✅ Yes | ✅ Yes | All |
BZip2CompressMBS.ProcessZip(Flush as boolean=false)
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
method | Compression | MBS Compression Plugin | 9.7 | ✅ Yes | ✅ Yes | ✅ Yes | ✅ Yes | All |
Reduces the size of the input buffer and writes new data to the output buffer.
If the input buffer is not empty after this call, you need to call it again, but empty the output buffer before.
Error is set.
If flush is true, the data is flushed to output. Using flush=true all the the time will slow down compression, so use it only on the end to clear the output buffers.
BZip2CompressMBS.SetInput(data as Memoryblock) as boolean
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
method | Compression | MBS Compression Plugin | 13.0 | ✅ Yes | ✅ Yes | ✅ Yes | ✅ Yes | All |
Returns true if successfull.
The current plugin uses a 128 K input buffer.
See also:
BZip2CompressMBS.SetInput(data as string) as boolean
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
method | Compression | MBS Compression Plugin | 9.7 | ✅ Yes | ✅ Yes | ✅ Yes | ✅ Yes | All |
Returns true if successfull.
The current plugin uses a 128 K input buffer.
See also:
The items on this page are in the following plugins: MBS Compression Plugin.