$Inflate: Difference between revisions
Jump to navigation
Jump to search
(Created page with "{{DISPLAYTITLE:$Inflate}} <span class="pageSubtitle"><section begin="desc" />Decompress a longstring with inflate<section end="desc" /></span> <p class="warning">Most Sirius $fu...") |
(Automatically generated page update) |
||
| (36 intermediate revisions by 6 users not shown) | |||
| Line 1: | Line 1: | ||
{{DISPLAYTITLE:$Inflate}} | {{DISPLAYTITLE:$Inflate}} | ||
<span class="pageSubtitle" | <span class="pageSubtitle">Decompress a longstring with inflate</span> | ||
<p class="warn"><b>Note: </b>Many $functions have been deprecated in favor of Object Oriented methods. The OO equivalent for the $Inflate function is the <var>[[Inflate (String function)|Inflate]]</var> function.</p> | |||
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. | 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. | The $Inflate function accepts one argument and returns a longstring result. The argument is the longstring to be decompressed, and it is required. | ||
==Syntax== | ==Syntax== | ||
<p class="syntax">< | <p class="syntax"><span class="term">%lstrc</span> = <span class="literal">$Inflate</span>(<span class="term">%lstr</span>, [<span class="term">option</span>]) | ||
< | |||
< | |||
</p> | </p> | ||
<p>%lstrc is the returned longstring.</p> | |||
Usage notes | ==Usage notes== | ||
<ul> | <ul> | ||
<li> If the input string is not a valid deflated string, the request is cancelled. | <li> If the input string is not a valid deflated string, the request is cancelled. | ||
<li> If compression is not enabled for the current run, the request is cancelled. | <li> If compression is not enabled for the current run, the request is cancelled. | ||
| Line 26: | Line 22: | ||
</ul> | </ul> | ||
==Examples== | |||
In the following example, %LSTR is set to the uncompressed version of the given string: | In the following example, %LSTR is set to the uncompressed version of the given string: | ||
<p class="code"> %LSTRC = $Deflate('How much wood could a woodchuck chuck', | <p class="code"> %LSTRC = $Deflate('How much wood could a woodchuck chuck', 'FIXED') | ||
%LSTR = $Inflate(%LSTRC) | %LSTR = $Inflate(%LSTRC) | ||
</p> | </p> | ||
==Products authorizing $Inflate== | |||
==Products authorizing {{PAGENAMEE}}== | |||
<ul class="smallAndTightList"> | <ul class="smallAndTightList"> | ||
<li>[[Sirius functions]]</li> | <li>[[List of $functions|Sirius functions]]</li> | ||
<li>[[Fast/Unload User Language Interface]]</li> | <li>[[Fast/Unload User Language Interface]]</li> | ||
<li>[[Janus Open Client]]</li> | <li>[[Media:JoclrNew.pdf|Janus Open Client]]</li> | ||
<li>[[Janus Open Server]]</li> | <li>[[Media:JosrvrNew.pdf|Janus Open Server]]</li> | ||
<li>[[Janus Sockets]]</li> | <li>[[Janus Sockets]]</li> | ||
<li>[[Janus Web Server]]</li> | <li>[[Janus Web Server]]</li> | ||
<li> | <li>Japanese functions</li> | ||
<li>[[Sir2000 Field Migration Facility]]</li> | <li>[[Media:SirfieldNew.pdf|Sir2000 Field Migration Facility]]</li> | ||
</ul> | </ul> | ||
[[Category:$Functions|$Inflate]] | [[Category:$Functions|$Inflate]] | ||
Latest revision as of 22:51, 20 September 2018
Decompress a longstring with inflate
Note: Many $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
%lstrc = $Inflate(%lstr, [option])
%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)