The LZInit function allocates memory for the internal data structures required to decompress files, and then creates and initializes them.
INT LZInit(
INT hfSource | // handle of source file |
); |
Parameters
hfSource
Identifies the source file.
Return Values
If the function succeeds, the return value is a new LZ file handle.
If the function fails, the return value is an LZERROR_* code. These codes have values less than zero. Note that LZInit calls neither SetLastError nor SetLastErrorEx; thus, its failure does not affect a thread's last-error code.
Here is a list of the LZERROR_* codes that LZInit can return upon failure:
Value | Meaning |
LZERROR_BADINHANDLE | The handle identifying the source file is not valid. The file cannot be read. |
LZERROR_GLOBALLOC | The maximum number of open compressed files has been exceeded or local memory cannot be allocated. |
LZERROR_GLOBLOCK | The LZ file handle cannot be locked down. |
LZERROR_UNKNOWNALG | The file is compressed with an unrecognized compression algorithm. |
Remarks
A maximum of 16 compressed files can be open at any given time. Similarly, a maximum of 16 uncompressed files can be open at any given time. An application should be careful to close the handle returned by LZInit when it is done using the file; otherwise, the application can inadvertently hit the 16-file limit.
The handle this function returns is compatible only with the functions in LZEXPAND.DLL; it should not be used for other file operations.