Monkeybread Xojo plugin - ZLibDecompressMBS class

Platforms to show: All Mac Windows Linux Cross-Platform

ZLibDecompressMBS class

Type	Topic	Plugin	Version	macOS	Windows	Linux	iOS	Targets
class	Compression	MBS Compression Plugin	3.3	✅ Yes	✅ Yes	✅ Yes	✅ Yes	All

A class for zlib decompression.

Example

// we do a one off compression
Var data as string = "Hello World Hello World"
Var z As new ZLibcompressMBS

z.InitZip(9)
call z.SetInput(data)
z.ProcessZip
z.EndZip

Var CompressedData as string = z.GetOutput

// and one off decompression
Var d As New ZLibDecompressMBS
d.InitZip
call d.SetInput(CompressedData)
d.ProcessZip
d.EndZip

Var UncompressedData as string = d.GetOutput

If UncompressedData = data Then
  MessageBox "match"
Else
  MessageBox "no match"
end if

See also ArchiveReaderMBS and ArchiveWriterMBS classes for more features and compression formats.

See ZLibCompressMBS class to compress first.

9 properties
- property CRC as UInt32
- property Error as Integer
- property ErrorMessage as String
- property OutputBufferSize as Integer
- property OutputPtr as Ptr
- property OutputUsedSize as Integer
- property TotalInput as Integer
- property TotalOutput as Integer
- property Version as String
15 methods
- method Adler32(start as UInt32, data as string) as UInt32
- method close
- method Constructor(BufferPtr as Ptr, BufferSize as Integer)
- method Constructor(BufferSize as Integer=20000)
- method CRC32(start as UInt32, data as string) as UInt32
- method EndZip
- method GetOutput as string
- method InitZip
- method InitZip(Raw as Boolean) New in 26.2
- method InputAvail as Integer
- method OutputSize as Integer
- method ProcessZip(Flush as boolean=false)
- method SetInput(data as Memoryblock) as boolean
- method SetInput(data as ptr, Size as Integer) as boolean
- method SetInput(data as string) as boolean
29 constants

Data Types

Constant	Value	Description
kASCII	1	ASCII
kBINARY	0	Binary
kTEXT	1	Text
kUNKNOWN	2	Unknown

Compression Levels

Constant	Value	Description
kBEST_COMPRESSION	9
kBEST_SPEED	1
kDEFAULT_COMPRESSION	-1
kNO_COMPRESSION	0

Flush modes

Constant	Value	Description
kBLOCK	5
kFINISH	4
kFULL_FLUSH	3
kNO_FLUSH	0
kPARTIAL_FLUSH	1
kSYNC_FLUSH	2

Errors

Constant	Value	Description
kBUF_ERROR	-5	Negative values are errors, positive values are used for special but normal events.
kDATA_ERROR	-3	Negative values are errors, positive values are used for special but normal events.
kERRNO	-1	Negative values are errors, positive values are used for special but normal events.
kMEM_ERROR	-4	Negative values are errors, positive values are used for special but normal events.
kNEED_DICT	2	Negative values are errors, positive values are used for special but normal events.
kOK	0	Negative values are errors, positive values are used for special but normal events.
kSTREAM_END	1	Negative values are errors, positive values are used for special but normal events.
kSTREAM_ERROR	-2	Negative values are errors, positive values are used for special but normal events.
kVERSION_ERROR	-6	Negative values are errors, positive values are used for special but normal events.

Compression Strategies

Constant	Value	Description
kDEFAULT_STRATEGY	0
kFILTERED	1
kFIXED	4
kHUFFMAN_ONLY	2
kRLE	3

Compression Methods

Constant	Value	Description
kDEFLATED	8	The deflate compression method (the only one supported in this version)

This class has no sub classes.

Blog Entries

Xojo Developer Magazine

24.4, page 10: News

Release notes

Version 26.2
- Added Raw parameter to InitZip methods in ZLibCompressMBS and ZLibDecompressMBS classes.
Version 24.3
- Added OutputUsedSize and OutputPtr properties and a new Constructor to BZip2CompressMBS, ZLibDecompressMBS, BZip2DecompressMBS and ZLibDecompressMBS classes.
- Added SetInput method taking ptr to ZLibDecompressMBS, ZLibCompressMBS, BZip2DecompressMBS and BZip2CompressMBS classes.

Some examples using this class:

Some related classes:

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

ZLibCompressMBS - ZStdMBS

💬 Ask a question or report a problem