Inflate (String function)

From m204wiki
Jump to navigation Jump to search

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.


%outString = string:Inflate Throws InvalidDeflateData

Syntax terms

%outString The resulting decompressed string.
string The compressed string to be decompressed.


Inflate can throw the following exception:

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 204initialization to allow use of the Inflate function; otherise, invoking Inflate causes request cancellation.


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

See also