$Deflate - Revision history

Tom at 13:54, 19 May 2026

2026-05-19T13:54:19Z

← Older revision		Revision as of 13:54, 19 May 2026
Line 4:		Line 4:
	<p class="warn"><b>Note: </b>Many $functions have been deprecated in favor of Object Oriented methods. The OO equivalent for the $Deflate function is the <var>[[Deflate (String function)\|Deflate]]</var> function.</p>		<p class="warn"><b>Note: </b>Many $functions have been deprecated in favor of Object Oriented methods. The OO equivalent for the $Deflate function is the <var>[[Deflate (String function)\|Deflate]]</var> function.</p>

	This function compresses a longstring using the "deflate" algorithm. The deflate algorithm is described completely in RFC 1951. It is very effective with HTML and XML data.		This function compresses a longstring using the "deflate" algorithm. The deflate algorithm is described completely in RFC 1951. It is very effective with HTML and XML data.

	The <var>$Deflate</var> function accepts two arguments and returns a longstring result.		The <var>$Deflate</var> function accepts two arguments and returns a longstring result.
Line 18:		Line 18:

	<tr><th>%lstr</th>		<tr><th>%lstr</th>
	<td>The longstring to be compressed; it is required. </td></tr>		<td>The longstring to be compressed; it is required.
			</td></tr>

	<tr><th>option</th>		<tr><th>option</th>
Line 29:		Line 30:
	<tr><th><var>DYNAMIC</var></th>		<tr><th><var>DYNAMIC</var></th>
	<td>Indicates that the compression code tables are generated based on the input data. Dynamic tables typically provide somewhat better compression on most types of data. There is a very slight CPU overhead in computing the frequencies of byte values in the input data. Also, since the code tables are dynamic, they are included as part of the compressed data. This will increase the size of the compressed longstring, but these tables are small, since they are also stored in a compressed form.		<td>Indicates that the compression code tables are generated based on the input data. Dynamic tables typically provide somewhat better compression on most types of data. There is a very slight CPU overhead in computing the frequencies of byte values in the input data. Also, since the code tables are dynamic, they are included as part of the compressed data. This will increase the size of the compressed longstring, but these tables are small, since they are also stored in a compressed form.
	</td></tr></table>		</td></tr>

			<tr><th><var>SOFTWARE</var></th>
			<td>[Introduced in Model 204 version 8.0]
			<p>Forces the use of software compression, bypassing the DFLTCC hardware instruction even when it is available on the processor (IBM z15 and above). Software compression uses the default DYNAMIC code tables. This can be useful for diagnostic purposes or when byte-for-byte reproducibility with pre-8.0 behavior is required.</p>
			<p>If the option is omitted (or FIXED or DYNAMIC is specified), hardware compression is used automatically when DFLTCC is available, falling back to software compression on older processors.</p>
			</td></tr>
			</table>
	</td></tr></table>		</td></tr></table>

	==Usage notes==		==Usage notes==
	<ul>		<ul>
	<li> If an invalid option is passed, or compression is not enabled for the current run, the request is cancelled.		<li> If an invalid option is passed, or compression is not enabled for the current run, the request is cancelled.
	<li> The NCMPBUF parameter must be set by User 0 before the <var>$Deflate</var> function can be used. If <var>$Deflate</var> is called with NCMPBUF = 0, the request is cancelled.		<li> The NCMPBUF parameter must be set by User 0 before the <var>$Deflate</var> function can be used. If <var>$Deflate</var> is called with NCMPBUF = 0, the request is cancelled.
	<li> 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 <var>$Deflate</var>.		<li> 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 <var>$Deflate</var>.

	<li> Short strings (less than 128 bytes) will typically compress better with the FIXED option.		<li> Short strings (less than 128 bytes) will typically compress better with the FIXED option.
	</ul>		</ul>
Line 44:		Line 53:
	<p class="code"> %LSTRC = $Deflate('How much wood could a woodchuck chuck', 'FIXED')		<p class="code"> %LSTRC = $Deflate('How much wood could a woodchuck chuck', 'FIXED')
	</p>		</p>
	<p>'''Note: ''' No other string or longstring functions can be usefully performed on the compressed string until it is decompressed with <var>[[$Inflate]]</var>.
			The following example forces software compression:
			<p class="code"> %LSTRC = $Deflate('How much wood could a woodchuck chuck', 'SOFTWARE')
			</p>

			<p>'''Note: ''' No other string or longstring functions can be usefully performed on the compressed string until it is decompressed with <var>[[$Inflate]]</var>.

	==Products authorizing $Deflate==		==Products authorizing $Deflate==
	==Products authorizing {{PAGENAMEE}}==		==Products authorizing {{PAGENAMEE}}==
	<ul class="smallAndTightList">		<ul class="smallAndTightList">
	<li>[[Sirius Functions]]</li>		<li>[[Sirius Functions]]</li>

JALWiccan: Automatically generated page update

2018-09-20T22:51:20Z

Automatically generated page update

← Older revision		Revision as of 22:51, 20 September 2018
Line 2:		Line 2:
	<span class="pageSubtitle">Compress a longstring with Deflate</span>		<span class="pageSubtitle">Compress a longstring with Deflate</span>

	<p class="warn"><b>Note: </b>~~Most Sirius~~ $functions have been deprecated in favor of Object Oriented methods. The OO equivalent for the $Deflate function is the <var>[[Deflate (String function)\|Deflate]]</var> function.</p>		<p class="warn"><b>Note: </b>Many $functions have been deprecated in favor of Object Oriented methods. The OO equivalent for the $Deflate function is the <var>[[Deflate (String function)\|Deflate]]</var> function.</p>

	This function compresses a longstring using the "deflate" algorithm. The deflate algorithm is described completely in RFC 1951. It is very effective with HTML and XML data.		This function compresses a longstring using the "deflate" algorithm. The deflate algorithm is described completely in RFC 1951. It is very effective with HTML and XML data.

JAL: /* Products authorizing {{PAGENAMEE}} */ fix "Sirius functions"

2018-09-20T21:59:55Z

Products authorizing {{PAGENAMEE}}: fix "Sirius functions"

← Older revision		Revision as of 21:59, 20 September 2018
Line 49:		Line 49:
	==Products authorizing {{PAGENAMEE}}==		==Products authorizing {{PAGENAMEE}}==
	<ul class="smallAndTightList">		<ul class="smallAndTightList">
	<li>[[~~List of $functions\|~~Sirius Functions]]</li>		<li>[[Sirius Functions]]</li>
	<li>[[Fast/Unload User Language Interface]]</li>		<li>[[Fast/Unload User Language Interface]]</li>
	<li>[[Media:JoclrNew.pdf\|Janus Open Client]]</li>		<li>[[Media:JoclrNew.pdf\|Janus Open Client]]</li>
Line 58:		Line 58:
	<li>[[Media:SirfieldNew.pdf\|Sir2000 Field Migration Facility]]</li>		<li>[[Media:SirfieldNew.pdf\|Sir2000 Field Migration Facility]]</li>
	</ul>		</ul>


	[[Category:$Functions\|$Deflate]]		[[Category:$Functions\|$Deflate]]

JALWiccan: Automatically generated page update

2018-09-20T21:52:26Z

Automatically generated page update

← Older revision		Revision as of 21:52, 20 September 2018
Line 49:		Line 49:
	==Products authorizing {{PAGENAMEE}}==		==Products authorizing {{PAGENAMEE}}==
	<ul class="smallAndTightList">		<ul class="smallAndTightList">
	<li>[[List of $functions\|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>[[Media:JoclrNew.pdf\|Janus Open Client]]</li>		<li>[[Media:JoclrNew.pdf\|Janus Open Client]]</li>

JALWiccan: Automatically generated page update

2015-02-19T23:08:58Z

Automatically generated page update

← Older revision		Revision as of 23:08, 19 February 2015
Line 56:		Line 56:
	<li>[[Janus Web Server]]</li>		<li>[[Janus Web Server]]</li>
	<li>Japanese functions</li>		<li>Japanese functions</li>
	<li>[[Media:SirfieldNew.pdf\|Sir2000 Field Migration Facility]</li>		<li>[[Media:SirfieldNew.pdf\|Sir2000 Field Migration Facility]]</li>
	</ul>		</ul>


	[[Category:$Functions\|$Deflate]]		[[Category:$Functions\|$Deflate]]

JALWiccan: Automatically generated page update

2015-02-19T22:57:51Z

Automatically generated page update

← Older revision		Revision as of 22:57, 19 February 2015
Line 56:		Line 56:
	<li>[[Janus Web Server]]</li>		<li>[[Janus Web Server]]</li>
	<li>Japanese functions</li>		<li>Japanese functions</li>
	<li>[~~http~~:~~//m204wiki.rocketsoftware.com/images/4/4b/~~SirfieldNew.pdf Sir2000 Field Migration Facility]</li>		<li>[[Media:SirfieldNew.pdf\|Sir2000 Field Migration Facility]</li>
	</ul>		</ul>


	[[Category:$Functions\|$Deflate]]		[[Category:$Functions\|$Deflate]]

JALWiccan: Automatically generated page update

2015-02-19T22:37:55Z

Automatically generated page update

← Older revision		Revision as of 22:37, 19 February 2015
Line 52:		Line 52:
	<li>[[Fast/Unload User Language Interface]]</li>		<li>[[Fast/Unload User Language Interface]]</li>
	<li>[[Media:JoclrNew.pdf\|Janus Open Client]]</li>		<li>[[Media:JoclrNew.pdf\|Janus Open Client]]</li>
	<li>[[Media:JosrvrNew.pdf\|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>

JALWiccan: Automatically generated page update

2015-02-19T22:34:29Z

Automatically generated page update

← Older revision		Revision as of 22:34, 19 February 2015
Line 52:		Line 52:
	<li>[[Fast/Unload User Language Interface]]</li>		<li>[[Fast/Unload User Language Interface]]</li>
	<li>[[Media:JoclrNew.pdf\|Janus Open Client]]</li>		<li>[[Media:JoclrNew.pdf\|Janus Open Client]]</li>
	<li>[~~http~~:~~//m204wiki.rocketsoftware.com/images/1/17/~~JosrvrNew.pdf 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>

JALWiccan: Automatically generated page update

2015-02-19T21:20:52Z

Automatically generated page update

← Older revision		Revision as of 21:20, 19 February 2015
Line 51:		Line 51:
	<li>[[List of $functions\|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>[[Media:JoclrNew.pdf\|Janus Open Client]</li>		<li>[[Media:JoclrNew.pdf\|Janus Open Client]]</li>
	<li>[http://m204wiki.rocketsoftware.com/images/1/17/JosrvrNew.pdf Janus Open Server]</li>		<li>[http://m204wiki.rocketsoftware.com/images/1/17/JosrvrNew.pdf Janus Open Server]</li>
	<li>[[Janus Sockets]]</li>		<li>[[Janus Sockets]]</li>

JALWiccan: Automatically generated page update

2015-02-19T21:17:14Z

Automatically generated page update

← Older revision		Revision as of 21:17, 19 February 2015
Line 51:		Line 51:
	<li>[[List of $functions\|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>[~~http~~:~~//m204wiki.rocketsoftware.com/images/4/4a/~~JoclrNew.pdf Janus Open Client]</li>		<li>[[Media:JoclrNew.pdf\|Janus Open Client]</li>
	<li>[http://m204wiki.rocketsoftware.com/images/1/17/JosrvrNew.pdf Janus Open Server]</li>		<li>[http://m204wiki.rocketsoftware.com/images/1/17/JosrvrNew.pdf Janus Open Server]</li>
	<li>[[Janus Sockets]]</li>		<li>[[Janus Sockets]]</li>