Platforms to show: All Mac Windows Linux Cross-Platform

Back to ZLibCompressMBS class.

ZLibCompressMBS.Adler32(start as UInt32, data as string) as UInt32

Type Topic Plugin Version macOS Windows Linux iOS Targets
method Compression MBS Compression Plugin 4.2 ✅ Yes ✅ Yes ✅ Yes ✅ Yes All
Calculates a 32bit Adler Checksum about a given string.

Set start to 0 for the first call.
Later you can pass the result as the new start value to add data to your checksum.

This function is part of the zlib library and given as a free utility function to this class.

ZLibCompressMBS.close

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

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.

ZLibCompressMBS.Constructor(BufferPtr as Ptr, BufferSize as Integer)   New in 24.3

Type Topic Plugin Version macOS Windows Linux iOS Targets
method Compression MBS Compression Plugin 24.3 ✅ Yes ✅ Yes ✅ Yes ✅ Yes All
The constructor taking an existing buffer.

For advanced users who use declares to preallocate the output buffer.
Stores Ptr in OutputPtr property for later access.

See also:

ZLibCompressMBS.Constructor(BufferSize as Integer=20000)

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

The buffer size you specify is the output buffer size.
If this size is small, you need to flush with ProcessZip.

See also:

ZLibCompressMBS.CRC32(start as UInt32, data as string) as UInt32

Type Topic Plugin Version macOS Windows Linux iOS Targets
method Compression MBS Compression Plugin 4.2 ✅ Yes ✅ Yes ✅ Yes ✅ Yes All
Calculates a 32bit Checksum about a given string.

Set start to 0 for the first call.
Later you can pass the result as the new start value to add data to your checksum.

This function is part of the zlib library and given as a free utility function to this class.

ZLibCompressMBS.EndZip

Type Topic Plugin Version macOS Windows Linux iOS Targets
method Compression MBS Compression Plugin 3.3 ✅ Yes ✅ Yes ✅ Yes ✅ Yes All
Finalizes the current compression stream.

You may check the Output buffer after this.
Error is set.

ZLibCompressMBS.GetOutput as string

Type Topic Plugin Version macOS Windows Linux iOS Targets
method Compression MBS Compression Plugin 3.3 ✅ Yes ✅ Yes ✅ Yes ✅ Yes All
Returns the contents of the output buffer.

The buffer is cleared after this function returns.

ZLibCompressMBS.InitZip(level as Integer)

Type Topic Plugin Version macOS Windows Linux iOS Targets
method Compression MBS Compression Plugin 3.3 ✅ Yes ✅ Yes ✅ Yes ✅ Yes All
Initializes the stream.

Level is from 0 to 9.
Error is set.

ZLibCompressMBS.InputAvail as Integer

Type Topic Plugin Version macOS Windows Linux iOS Targets
method Compression MBS Compression Plugin 3.3 ✅ Yes ✅ Yes ✅ Yes ✅ Yes All
Returns the number of bytes available in the input buffer.

ZLibCompressMBS.OutputSize as Integer

Type Topic Plugin Version macOS Windows Linux iOS Targets
method Compression MBS Compression Plugin 3.3 ✅ Yes ✅ Yes ✅ Yes ✅ Yes All
The size of bytes available in the output buffer.

ZLibCompressMBS.ProcessFinish

Type Topic Plugin Version macOS Windows Linux iOS Targets
method Compression MBS Compression Plugin 14.4 ✅ Yes ✅ Yes ✅ Yes ✅ Yes All
Same as process, but for finishing.

If error is zero after this function, please call it again.
Error is 1 if stream is at end, so you can call EndZip to finish.

ZLibCompressMBS.ProcessZip(Flush as boolean=false)

Type Topic Plugin Version macOS Windows Linux iOS Targets
method Compression MBS Compression Plugin 3.3 ✅ Yes ✅ Yes ✅ Yes ✅ Yes All
Does zip compression.

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.

ZLibCompressMBS.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
Fills the input buffer.

Returns true if successfull.
Returns false if size is <= 0.

The data is read directly from the Memoryblock and the plugin keeps a reference until destructor runs or you set a new input data.

See also:

ZLibCompressMBS.SetInput(data as ptr, Size as Integer) as boolean   New in 24.3

Type Topic Plugin Version macOS Windows Linux iOS Targets
method Compression MBS Compression Plugin 24.3 ✅ Yes ✅ Yes ✅ Yes ✅ Yes All
Fills the input buffer.

Returns true if successfull.
Returns false if Size is <= 0.

The data is read directly from the Ptr and you need to keep reference to the memory and prevent it from being released too early.

See also:

ZLibCompressMBS.SetInput(data as string) as boolean

Type Topic Plugin Version macOS Windows Linux iOS Targets
method Compression MBS Compression Plugin 3.3 ✅ Yes ✅ Yes ✅ Yes ✅ Yes All
Fills the input buffer.

Returns true if successfull.
Returns false if length is <= 0.

The data is read directly from the String and the plugin keeps a reference until destructor runs or you set a new input data.#

See also:

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


The biggest plugin in space...