BZip2DecompressMBS.Close

Type	Topic	Plugin	Version	macOS	Windows	Linux	iOS	Targets
method	Compression	MBS Compression Plugin	9.7	✅ 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.

BZip2DecompressMBS.Constructor(BufferPtr as Ptr, BufferSize as Integer)

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:

• Constructor(BufferSize as Integer=20000)

BZip2DecompressMBS.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 constructor.

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

See also:

• Constructor(BufferPtr as Ptr, BufferSize as Integer)

BZip2DecompressMBS.EndZip

Type	Topic	Plugin	Version	macOS	Windows	Linux	iOS	Targets
method	Compression	MBS Compression Plugin	9.7	✅ Yes	✅ Yes	✅ Yes	✅ Yes	All

Finalizes the current decompression stream.

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

BZip2DecompressMBS.GetOutput as string

Type	Topic	Plugin	Version	macOS	Windows	Linux	iOS	Targets
method	Compression	MBS Compression Plugin	9.7	✅ Yes	✅ Yes	✅ Yes	✅ Yes	All

Returns the content of the output buffer.

The buffer is cleared after this function returns.

BZip2DecompressMBS.InitZip

Type	Topic	Plugin	Version	macOS	Windows	Linux	iOS	Targets
method	Compression	MBS Compression Plugin	9.7	✅ Yes	✅ Yes	✅ Yes	✅ Yes	All

Initializes the stream.

Error is set.

BZip2DecompressMBS.InputAvail as Integer

Type	Topic	Plugin	Version	macOS	Windows	Linux	iOS	Targets
method	Compression	MBS Compression Plugin	9.7	✅ Yes	✅ Yes	✅ Yes	✅ Yes	All

Returns the number of bytes available in the input buffer.

BZip2DecompressMBS.OutputSize as Integer

Type	Topic	Plugin	Version	macOS	Windows	Linux	iOS	Targets
method	Compression	MBS Compression Plugin	9.7	✅ Yes	✅ Yes	✅ Yes	✅ Yes	All

The size of bytes available in the output buffer.

BZip2DecompressMBS.ProcessZip

Type	Topic	Plugin	Version	macOS	Windows	Linux	iOS	Targets
method	Compression	MBS Compression Plugin	9.7	✅ 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 "" after this call, you need to call it again, but empty the output buffer before.
Error is set.

BZip2DecompressMBS.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:

• SetInput(data as ptr, Size as Integer) as boolean
• SetInput(data as string) as boolean

BZip2DecompressMBS.SetInput(data as ptr, Size as Integer) as boolean

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:

• SetInput(data as Memoryblock) as boolean
• SetInput(data as string) as boolean

BZip2DecompressMBS.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

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:

• SetInput(data as Memoryblock) as boolean
• SetInput(data as ptr, Size as Integer) as boolean