Gzip (String function): Difference between revisions

From m204wiki
Jump to navigation Jump to search
mNo edit summary
Line 3: Line 3:
==Syntax==
==Syntax==
{{Template:String:Gzip syntax}}
{{Template:String:Gzip syntax}}
===Syntax terms===
===Syntax terms===
<table class="syntaxTable">
<table class="syntaxTable">
<tr><th>%outString</th><td>The result of the GZIP operation, compressing the method object <var class="term">string</var>.</td></tr>
<tr><th>%outString</th>
<td>The result of the GZIP operation, compressing the method object <var class="term">string</var>.</td></tr>
 
<tr><th>string</th>
<tr><th>string</th>
<td>The string to be compressed by the GZIP operation.</td></tr>
<td>The string to be compressed by the GZIP operation.</td></tr>
<tr><th><var>FixedCode</var></th>
<tr><th><var>FixedCode</var></th>
<td><var>Boolean</var> value ([[under construction]]).</td></tr>
<td><var>Boolean</var> value ([[under construction]]).</td></tr>
<tr><th><var>LazyMatch</var></th>
<tr><th><var>LazyMatch</var></th>
<td><var>Boolean</var> value ([[under construction]])</td></tr>
<td><var>Boolean</var> value ([[under construction]])</td></tr>
<tr><th><var>MaxChain</var></th>
<tr><th><var>MaxChain</var></th>
<td>number ([[under construction]])</td></tr>
<td>number ([[under construction]])</td></tr>
<tr><th><var>Filename</var></th>
<tr><th><var>Filename</var></th>
<td>string ([[under construction]])</td></tr>
<td>string ([[under construction]])</td></tr>
<tr><th><var>LastModified</var></th>
<tr><th><var>LastModified</var></th>
<td>The date/time stamp to be stored as a component of <var class="term">%outString</var>, expressed as the number of milliseconds since 12:00 AM, Jan 1, 1900. The default is the current date and time (that is, <var>[[CurrentTimeMilliseconds (System function)|%(System):CurrentTimeMilliseconds]]</var>).
<td>The date/time stamp to be stored as a component of <var class="term">%outString</var>, expressed as the number of milliseconds since 12:00 AM, Jan 1, 1900. The default is the current date and time (that is, <var>[[CurrentTimeMilliseconds (System function)|%(System):CurrentTimeMilliseconds]]</var>).
Line 24: Line 32:


==Usage notes==
==Usage notes==
==See also==
<ul>
<ul>
<li>The inverse of <var>Gzip</var> is <var>[[Gunzip (String function)|Gunzip]]</var>.
<li>The inverse of <var>Gzip</var> is <var>[[Gunzip (String function)|Gunzip]]</var>.
</ul>
<li>Other related methods:  
 
==Examples==
==See also==
Related methods:
<ul>
<ul>
<li><var>[[Gunzip (String function)|Gunzip]]</var>
<li><var>[[Deflate (String function)|Deflate]]</var>
<li><var>[[Deflate (String function)|Deflate]]</var>
<li><var>[[Inflate (String function)|Inflate]]</var>
</ul>
</ul>
</ul>


{{Template:String:Gzip footer}}
{{Template:String:Gzip footer}}

Revision as of 18:31, 8 August 2012

Compress a longstring with GZIP (String class)

[Introduced in Sirius Mods 7.4]


Syntax

%outString = string:Gzip[( [FixedCode= boolean], [LazyMatch= boolean], - [MaxChain= number], [Filename= string], - [LastModified= number])]

Syntax terms

%outString The result of the GZIP operation, compressing the method object string.
string The string to be compressed by the GZIP operation.
FixedCode Boolean value (under construction).
LazyMatch Boolean value (under construction)
MaxChain number (under construction)
Filename string (under construction)
LastModified The date/time stamp to be stored as a component of %outString, expressed as the number of milliseconds since 12:00 AM, Jan 1, 1900. The default is the current date and time (that is, %(System):CurrentTimeMilliseconds).

After Gzip stores a value into %outString, the LastModified date/time stamp can be obtained with the GunzipDatetimeNS function, but note that its output is in seconds, not milliseconds.

Usage notes

See also