Zip (String function)
Compress a longstring with ZIP (String class)
[Introduced in Sirius Mods 7.4]
%outString = string:Zip[( [FixedCode= boolean], [LazyMatch= boolean], - [MaxChain= number], [Filename= string], - [LastModified= number])]
|%outString||The result of the ZIP operation, compressing the method object string.|
|string||The string to be compressed by the ZIP operation.|
|FixedCode||FixedCode is an optional, name required, parameter that is a Boolean value that specifies whether the compression uses fixed codes or is dynamic, based on the contents of the input string.
|LazyMatch||LazyMatch is an optional, name required, parameter that is a Boolean value that specifies whether to use "lazy match" compression, as specified in RFC 1951. The default value for this argument is False (do not use "lazy match" compression).|
|MaxChain||MaxChain 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.|
|Filename||Filename 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.|
|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).|
- The NCMPBUF parameter must be set by User 0 before Zip can be used. If Zip is called and the NCMPBUF value is 0, the request is cancelled.