Inflate (String function): Difference between revisions

From m204wiki
Jump to navigation Jump to search
mNo edit summary
No edit summary
 
(5 intermediate revisions by one other user not shown)
Line 1: Line 1:
{{Template:String:Inflate subtitle}}
{{Template:String:Inflate subtitle}}
This function takes a result from <var>[[Deflate (String function)|Deflate]]</var> (a compressed string) 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 result from <var>[[Deflate (String function)|Deflate]]</var> (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==
==Syntax==
Line 6: Line 5:
===Syntax terms===
===Syntax terms===
<table class="syntaxTable">
<table class="syntaxTable">
<tr><th>%outString</th><td>The result decompressed string.</td></tr>
<tr><th>%outString</th>
<td>The resulting decompressed string.</td></tr>
 
<tr><th>string</th>
<tr><th>string</th>
<td>The compressed string to be decompressed.</td></tr>
<td>The compressed string to be decompressed.</td></tr>
</table>
</table>
==Exceptions==
==Exceptions==
<var>Inflate</var> can throw the following exception:
<var>Inflate</var> can throw the following exception:
Line 20: Line 22:
<ul>
<ul>
<li>The <var>[[NCMPBUF parameter|NCMPBUF]]</var> parameter must be set to a
<li>The <var>[[NCMPBUF parameter|NCMPBUF]]</var> parameter must be set to a
non-0 value during <var class="product">Model 204</var>initialization to allow
non-zero value during <var class="product">Model 204</var>initialization to allow
use of the <var>Inflate</var> function; otherise, invoking <var>Inflate</var>
use of the <var>Inflate</var> function; otherise, invoking <var>Inflate</var>
causes request cancellation.
causes request cancellation.
</ul>
</ul>
==Examples==
==Examples==
In the following example, <code>%out</code> is set to the original string (<code>How much</code>..<code>chuck</code>):
In the following example, <code>%out</code> is set to the original string (<code>How much</code>..<code>chuck</code>):
Line 31: Line 34:
==See also==
==See also==
<ul>
<ul>
<li>[[??]]
<li><var>[[Deflate (String function)|Deflate]]</var> is used to compress a string using the "deflate" algorithm.
<li>Other related methods:
<ul>
<li><var>[[Gunzip (String function)|Gunzip]]</var>
<li><var>[[GunzipDatetimeNS (String function)|GunzipDatetimeNS]]</var>
<li><var>[[GunzipFilename (String function)|GunzipFilename]]</var>
<li><var>[[Gzip (String function)|Gzip]]</var>
<li><var>[[Zip (String function)|Zip]]</var>
</ul>
</ul>
</ul>
 
{{Template:String:Inflate footer}}
{{Template:String:Inflate footer}}

Latest revision as of 21:28, 3 September 2015

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.

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

See also