Platforms to show: All Mac Windows Linux Cross-Platform

Back to GZipFileMBS class.

GZipFileMBS.Direct as Boolean

Type Topic Plugin Version macOS Windows Linux iOS Targets
property Compression MBS Compression Plugin 17.5 ✅ Yes ✅ Yes ✅ Yes ✅ Yes All
Returns true if file is being copied directly while reading, or false if file is a gzip stream being decompressed.

If the input file is empty, Direct will return true, since the input does not contain a gzip stream.
(Read only property)

GZipFileMBS.EOF as Boolean

Type Topic Plugin Version macOS Windows Linux iOS Targets
property Compression MBS Compression Plugin 4.2 ✅ Yes ✅ Yes ✅ Yes ✅ Yes All
Returns true if reading is on the end of the file.

Returns true on any error.
(Read only property)

GZipFileMBS.ErrorCode as Integer

Type Topic Plugin Version macOS Windows Linux iOS Targets
property Compression MBS Compression Plugin 4.2 ✅ Yes ✅ Yes ✅ Yes ✅ Yes All
Returns the last zlib error number.

If an error occurred in the file system and not in the compression library, errnum is set to Z_ERRNO and the application may consult errno to get the exact error code. (errno is currently not available in Xojo)

Error codes:
Z_OK 0
Z_STREAM_END 1
Z_NEED_DICT 2
Z_ERRNO -1
Z_STREAM_ERROR-2
Z_DATA_ERROR -3
Z_MEM_ERROR -4
Z_BUF_ERROR -5
Z_VERSION_ERROR-6
(Read only property)

GZipFileMBS.ErrorMessage as String

Type Topic Plugin Version macOS Windows Linux iOS Targets
property Compression MBS Compression Plugin 4.2 ✅ Yes ✅ Yes ✅ Yes ✅ Yes All
Returns the error message for the last error which occurred on the given compressed file.

(Read only property)

GZipFileMBS.Handle as Integer

Type Topic Plugin Version macOS Windows Linux iOS Targets
property Compression MBS Compression Plugin 4.2 ✅ Yes ✅ Yes ✅ Yes ✅ Yes All
The current zlib file handle.

(Read and Write property)

GZipFileMBS.Lasterror as Integer

Type Topic Plugin Version macOS Windows Linux iOS Targets
property Compression MBS Compression Plugin 4.2 ✅ Yes ✅ Yes ✅ Yes ✅ Yes All
The last error code reported.

0 for success.
-1 for failure.
(Read and Write property)

GZipFileMBS.Position as Integer

Type Topic Plugin Version macOS Windows Linux iOS Targets
property Compression MBS Compression Plugin 4.2 ✅ Yes ✅ Yes ✅ Yes ✅ Yes All
The current file position.

Not all positions are available.
e.g. on writing you can not move back.
Moving forward will add bytes with value 0 to the file.
Lasterror is set.
(Read and Write property)

GZipFileMBS.Version as String

Type Topic Plugin Version macOS Windows Linux iOS Targets
property Compression MBS Compression Plugin 4.2 ✅ Yes ✅ Yes ✅ Yes ✅ Yes All
The version string of the used zlib library.

(Read only property)

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


The biggest plugin in space...