Zip (String function) - Revision history

ELowell at 23:16, 3 September 2015

2015-09-03T23:16:34Z

← Older revision		Revision as of 23:16, 3 September 2015
Line 1:		Line 1:
	{{Template:String:Zip subtitle}}		{{Template:String:Zip subtitle}}


	==Syntax==		==Syntax==
	{{Template:String:Zip syntax}}		{{Template:String:Zip syntax}}

JAL2 at 19:36, 9 August 2012

2012-08-09T19:36:22Z

← Older revision		Revision as of 19:36, 9 August 2012
Line 1:		Line 1:
	{{Template:String:Zip subtitle}}		{{Template:String:Zip subtitle}}

	~~This page is [[under construction]].~~
	==Syntax==		==Syntax==
	{{Template:String:Zip syntax}}		{{Template:String:Zip syntax}}

	===Syntax terms===		===Syntax terms===
	<table class="syntaxTable">		<table class="syntaxTable">
	<tr><th>%outString</th>		<tr><th>%outString</th>
	<td>The result of the ZIP operation, compressing the method object <var class="term">string</var>.</td></tr>		<td>The result of the ZIP 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 ZIP operation.</td></tr>		<td>The string to be compressed by the ZIP operation.</td></tr>
Line 31:		Line 33:

	<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>).</td></tr>
	</td></tr>
	</table>		</table>

	==Usage notes==		==Usage notes==
	~~==Examples==~~		<ul>
			<li>The <var>[[NCMPBUF parameter\|NCMPBUF]]</var> parameter must be set by User 0 before <var>Zip</var> can be used. If <var>Zip</var> is called and the <var>NCMPBUF</var> value is 0, the request is cancelled.
			</ul>

	==See also==		==See also==
	<ul>		<ul>

JAL2: /* Syntax terms */

2012-08-09T18:59:11Z

Syntax terms

← Older revision		Revision as of 18:59, 9 August 2012
Line 6:		Line 6:
	===Syntax terms===		===Syntax terms===
	<table class="syntaxTable">		<table class="syntaxTable">
	<tr><th>%outString</th><td>string</td></tr>		<tr><th>%outString</th>
			<td>The result of the ZIP operation, compressing the method object <var class="term">string</var>.</td></tr>
	<tr><th>string</th>		<tr><th>string</th>
	<td>string</td></tr>		<td>The string to be compressed by the ZIP operation.</td></tr>

	<tr><th><var>FixedCode</var></th>		<tr><th><var>FixedCode</var></th>
	<td><var>Boolean</var> value<br/>This ~~argument is optional; its~~ default value is ~~[[??]]~~.</td></tr>		<td><var>FixedCode</var> is an optional, [[Notation conventions for methods#Named parameters\|name required]], parameter that is a <var>[[Boolean_enumeration#Using_Boolean_enumerations\|Boolean]]</var> value that specifies whether the compression uses fixed codes or is dynamic, based on the contents of the input <var class="term">string</var>.
			<ul>
			<li>With fixed code compression (<code>fixedCode=true</code>), the tables used for compression (defined as part of RFC 1951) are somewhat optimized for ASCII character data, but they slightly decrease the amount of CPU required to perform compression. Also, since the codes are already defined as part of the specification, they are not included in the compressed data.
			<li>With dynamic compression (<code>fixedCode=false</code>), 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.
			</ul>
			The default value for this argument is <var>False</var> (use dynamic compression).</td></tr>

	<tr><th><var>LazyMatch</var></th>		<tr><th><var>LazyMatch</var></th>
	<td><var>~~Boolean~~</var> ~~value~~<br/>~~This argument is optional; its~~ default value is ~~[[??]]~~.</td></tr>		<td><var>LazyMatch</var> is an optional, name required, parameter that is a <var>Boolean</var> value that specifies whether to use "lazy match" compression, as specified in RFC 1951.
			The default value for this argument is <var>False</var> (do not use "lazy match" compression).</td></tr>

	<tr><th><var>MaxChain</var></th>		<tr><th><var>MaxChain</var></th>
	<td>~~number~~<br/>~~This argument~~ is optional~~; its~~ default value is ~~[[??]]~~.</td></tr>		<td><var>MaxChain</var> is an optional, name required, parameter that is a numeric value that specifies the maximum hash chain length, as explained in RFC 1951.
			The default value for this argument is 0. If specified, it must be between 0 and 99, inclusive.</td></tr>

	<tr><th><var>Filename</var></th>		<tr><th><var>Filename</var></th>
	<td>~~string~~<br/>~~This argument~~ is optional~~; its default value~~ is ~~[[??]]~~.</td></tr>		<td><var>Filename</var> is an optional, name required, parameter that is a string to be stored as the internal name of the compressed string. Decompression programs will use this name for the output file when the string is un-zipped. The maximum length of the file name is 32 bytes.</td></tr>

	<tr><th><var>LastModified</var></th>		<tr><th><var>LastModified</var></th>
	<td>~~number~~<br/>~~This argument~~ is ~~optional; its default value~~ is [[??]].</td></tr>		<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></tr>
	</table>		</table>

	==Usage notes==		==Usage notes==
	==Examples==		==Examples==

JAL2: /* See also */

2012-08-09T18:28:04Z

JAL2: /* See also */

2012-08-09T18:27:21Z

JAL2: /* See also */

2012-08-09T18:26:55Z

DmeWiccan: Automatically generated page update

2012-08-01T03:18:34Z

Automatically generated page update

New page

{{Template:String:Zip subtitle}}

This page is [[under construction]].
==Syntax==
{{Template:String:Zip syntax}}
===Syntax terms===
<table class="syntaxTable">
<tr><th>%outString</th><td>string</td></tr>
<tr><th>string</th>
<td>string</td></tr>
<tr><th><var>FixedCode</var></th>
<td><var>Boolean</var> value<br/>This argument is optional; its default value is [[??]].</td></tr>
<tr><th><var>LazyMatch</var></th>
<td><var>Boolean</var> value<br/>This argument is optional; its default value is [[??]].</td></tr>
<tr><th><var>MaxChain</var></th>
<td>number<br/>This argument is optional; its default value is [[??]].</td></tr>
<tr><th><var>Filename</var></th>
<td>string<br/>This argument is optional; its default value is [[??]].</td></tr>
<tr><th><var>LastModified</var></th>
<td>number<br/>This argument is optional; its default value is [[??]].</td></tr>
</table>
==Usage notes==
==Examples==
==See also==
{{Template:String:Zip footer}}

← Older revision		Revision as of 18:28, 9 August 2012
Line 23:		Line 23:
	==Examples==		==Examples==
	==See also==		==See also==
			<ul>
	<li>Other related methods:		<li>Other related methods:
	<ul>		<ul>

← Older revision		Revision as of 18:27, 9 August 2012
Line 31:		Line 31:
	<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>

	{{Template:String:Zip footer}}		{{Template:String:Zip footer}}

@@ Line 23: / Line 23: @@
 ==Examples==
 ==See also==
 {{Template:String:Zip footer}}