$GunZip
<section begin="desc" />Decompress a longstring with GUNZIP<section end="desc" />
Most Sirius $functions have been deprecated in favor of Object Oriented methods. The OO equivalent for the $GunZip function is to be entered.
This function extracts information from a GZIP-format longstring.
The $GunZip function accepts two arguments and returns a longstring result.
Syntax
<section begin="syntax" /> %lstrc = $GunZip(%lstr, type) <section end="syntax" />
$GunZip Function
%lstrc is the returned longstring.
The first argument, the longstring to be decompressed, is required. The string must be in GZIP format.
The second argument is a string indicating what information should be extracted from the GZIP-format longstring. This argument is optional; if it is not specified, DATA is assumed, and the longstring is decompressed into the result longstring. Valid options and their meanings are:
| DATA | Indicates that the data in the GZIP longstring is extracted. This is the default. |
|---|---|
| TIME | Indicates that the date and time, known as the "modification time," is returned (in the form YYYY-MM-DD HH:MI:SS:elit.). |
| NAME | Indicates that the internal name of the GZIP entity is returned in the result. If no internal name is present, the null string is returned. |
Usage notes:
- If an invalid option is passed, or if compression is not enabled for the current run, the request is cancelled.
- The NCMPBUF parameter must be set by User 0 before the $GZip function can be used. If $GunZip is called with NCMPBUF = 0, the request is cancelled.
In the following example,
%ls = $GunZip(%lsgz)
In the following example,
%dt = $GunZip(%lsgz, 'TIME')
GZIP-format files can be created with the function $GZip , as well as other file compression utilities. :enote
- Sirius functions
- Fast/Unload User Language Interface
- Janus Open Client
- Janus Open Server
- Janus Sockets
- Janus Web Server
- Japanese functions
- Sir2000 Field Migration Facility
Products authorizing $GunZip