Gunzip (String function): Difference between revisions
Jump to navigation
Jump to search
m (→Syntax terms) |
No edit summary |
||
| (7 intermediate revisions by 2 users not shown) | |||
| Line 1: | Line 1: | ||
{{Template:String:Gunzip subtitle}} | {{Template:String:Gunzip subtitle}} | ||
This function extracts information from a GZIP-format longstring. | |||
==Syntax== | ==Syntax== | ||
{{Template:String:Gunzip syntax}} | {{Template:String:Gunzip syntax}} | ||
===Syntax terms=== | ===Syntax terms=== | ||
<table class="syntaxTable"> | <table class="syntaxTable"> | ||
<tr><th>%outString</th><td>The decompressed content of the | <tr><th>%outString</th> | ||
<td>The decompressed content of the <var class="term">string</var> method object.</td></tr> | |||
<tr><th>string</th> | <tr><th>string</th> | ||
<td>A string which has been assigned the output of a <var>[[Gunzip (String function)|Gunzip]]</var> invocation.</td></tr> | <td>A string which has been assigned the output of a <var>[[Gunzip (String function)|Gunzip]]</var> invocation.</td></tr> | ||
| Line 11: | Line 15: | ||
==Usage notes== | ==Usage notes== | ||
<ul> | |||
<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 | |||
use of the <var>Gunzip</var> function; otherise, invoking <var>Gunzip</var> | |||
causes request cancellation. | |||
</ul> | |||
==See also== | ==See also== | ||
| Line 17: | Line 27: | ||
<li>Other related methods: | <li>Other related methods: | ||
<ul> | <ul> | ||
<li><var>[[GunzipDatetimeNS (String function)|GunzipDatetimeNS]]</var> | |||
<li><var>[[GunzipFilename (String function)|GunzipFilename]]</var> | |||
<li><var>[[Zip (String function)|Zip]]</var> | |||
<li><var>[[Deflate (String function)|Deflate]]</var> | <li><var>[[Deflate (String function)|Deflate]]</var> | ||
<li><var>[[Inflate (String function)|Inflate ]]</var> | <li><var>[[Inflate (String function)|Inflate]]</var> | ||
</ul> | </ul> | ||
</ul> | </ul> | ||
{{Template:String:Gunzip footer}} | {{Template:String:Gunzip footer}} | ||
Latest revision as of 21:10, 3 September 2015
Decompress a longstring with GUNZIP (String class)
[Introduced in Sirius Mods 7.4]
This function extracts information from a GZIP-format longstring.
Syntax
%outString = string:Gunzip Throws InvalidGZipData
Syntax terms
| %outString | The decompressed content of the string method object. |
|---|---|
| string | A string which has been assigned the output of a Gunzip invocation. |
Usage notes
- The NCMPBUF parameter must be set to a non-0 value during Model 204 initialization to allow use of the Gunzip function; otherise, invoking Gunzip causes request cancellation.
See also
- The inverse of Gunzip is Gzip.
- Other related methods: