Gunzip (String function)

Decompress a longstring with GUNZIP (String class)

[Introduced in Sirius Mods 7.4]

This function extracts information from a GZIP-format longstring.

Syntax

%outString = string:Gunzip[( [Software= boolean])] Throws InvalidGZipData

Syntax terms

%outString	The decompressed content of the string method object.
string	A string which has been assigned the output of a Gzip invocation.
Software	[Introduced in Model 204 version 8.0] Software is an optional, name required, parameter that is a Boolean value that specifies whether to force the use of software decompression instead of hardware decompression. When software=true, decompression is always performed in software, even if the DFLTCC hardware instruction is available on the processor. This can be useful for diagnostic purposes or when byte-for-byte reproducibility with pre-8.0 behavior is required. When software=false (the default), hardware decompression is used automatically when DFLTCC is available (IBM z15 and above), falling back to software decompression on older processors. The default value for this argument is False.

Usage notes

• The NCMPBUF parameter must be set to a non-0 value during Model 204 initialization to allow use of the Gunzip function; otherwise, invoking Gunzip causes request cancellation.

Examples

The following example decompresses a GZIP-format string:

%out = %compressed:Gunzip

The following example forces software decompression:

%out = %compressed:Gunzip(software=true)

See also

• The inverse of Gunzip is Gzip.
• Other related methods:
  • GunzipDatetimeNS
  • GunzipFilename
  • Zip
  • Deflate
  • Inflate

Float class String class Unicode class	List of Float methods List of String methods List of Unicode methods List of Intrinsic methods	Float methods syntax String methods syntax Unicode methods syntax
Notation conventions for methods