$Inflate: Difference between revisions

From m204wiki
Jump to navigation Jump to search
mNo edit summary
Line 28: Line 28:
</p>
</p>


==Products authorizing $Inflate==
<ul class="smallAndTightList">
<ul class="smallAndTightList">
<li>[[Sirius functions]]</li>
<li>[[Sirius functions]]</li>
Line 38: Line 39:
<li>[[Sir2000 Field Migration Facility]]</li>
<li>[[Sir2000 Field Migration Facility]]</li>
</ul>
</ul>
<p class="caption">Products authorizing $Inflate
 
</p>


[[Category:$Functions|$Inflate]]
[[Category:$Functions|$Inflate]]

Revision as of 22:39, 24 October 2012

Decompress a longstring with inflate

Most Sirius $functions have been deprecated in favor of Object Oriented methods. The OO equivalent for the $Inflate function is the Inflate function.

This function takes a deflated longstring input and decompresses it using the "inflate" algorithm. The inflate algorithm is described as part of the deflate specification in RFC 1951.

The $Inflate function accepts one argument and returns a longstring result. The argument is the longstring to be decompressed, and it is required.

Syntax

<section begin="syntax" />%lstrc = $Inflate(%lstr, option) <section end="syntax" />

%lstrc is the returned longstring.

Usage notes

  • If the input string is not a valid deflated string, the request is cancelled.
  • If compression is not enabled for the current run, the request is cancelled.
  • The NCMPBUF parameter must be set by User 0 before the $Inflate function can be used. If $Inflate is called with NCMPBUF = 0, the request is cancelled.
  • As with any compression scheme, it is possible that a particular string will become longer after compression. This would happen, for example, if a deflated string were passed to $Deflate .

Examples

In the following example, %LSTR is set to the uncompressed version of the given string:

%LSTRC = $Deflate('How much wood could a woodchuck chuck', 'FIXED') %LSTR = $Inflate(%LSTRC)

Products authorizing $Inflate