LZClose function (lzexpand.h)

Article
10/13/2021

Closes a file that was opened by using the LZOpenFile function.

Syntax

void LZClose(
  [in] INT hFile
);

Parameters

[in] hFile

A handle to the file to be closed.

Return value

None

Remarks

The handle identifying the file must be retrieved by calling the LZOpenFile function. If the handle is retrieved by calling the CreateFile or OpenFile function, an error occurs.

If the file has been compressed by the Lempel-Ziv algorithm and opened by using LZOpenFile, LZClose frees any global heap space that was allocated to expand the file.

In Windows 8 and Windows Server 2012, this function is supported by the following technologies.

Technology	Supported
Server Message Block (SMB) 3.0 protocol	Yes
SMB 3.0 Transparent Failover (TFO)	Yes
SMB 3.0 with Scale-out File Shares (SO)	Yes
Cluster Shared Volume File System (CsvFS)	Yes
Resilient File System (ReFS)	Yes

CsvFs will do redirected IO for compressed files.

Requirements

Requirement	Value
Minimum supported client	Windows XP [desktop apps only]
Minimum supported server	Windows Server 2003 [desktop apps only]
Target Platform	Windows
Header	lzexpand.h (include Windows.h)
Library	Lz32.lib
DLL	Lz32.dll