Inflate (String function)

Decompress a longstring with inflate (String class)

[Introduced in Sirius Mods 7.4]

This function takes a result from Deflate (a compressed string) and decompresses it using the "inflate" algorithm. The inflate algorithm is described as part of the deflate specification in RFC 1951.

Syntax

%outString = string:Inflate Throws InvalidDeflateData

Syntax terms

%outString	The resulting decompressed string.
string	The compressed string to be decompressed.
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.

Exceptions

Inflate can throw the following exception:

InvalidDeflateData

This exception indicates that the method object string does not contain a valid Deflate string compression output.

Usage notes

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

Examples

In the following example, %out is set to the original string (How much..chuck):

%temp = 'How much wood could a woodchuck chuck':deflate(fixedCode=true) %out = %temp:Inflate

The following example forces software decompression:

%out = %temp:Inflate(software=true)

See also

• Deflate is used to compress a string using the "deflate" algorithm.
• Other related methods:
  • Gunzip
  • GunzipDatetimeNS
  • GunzipFilename
  • Gzip
  • Zip

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