Reads (at most) the specified number of bytes from a file and copies them into a buffer.
Syntax
|
INT WINAPI LZRead(
__in INT hFile,
__out LPSTR lpBuffer,
__in INT cbRead
);
|
Parameters
- hFile [in]
-
A handle to the file.
- lpBuffer [out]
-
A pointer to a buffer that receives the bytes read from the file. Ensure that this buffer is larger than cbRead.
- cbRead [in]
-
The count of bytes to be read.
Return Value
If the function succeeds, the return value specifies the number of bytes read.
If the function fails, the return value is an LZERROR_* code. These codes have values less than zero. Note that
LZRead calls neither SetLastError nor SetLastErrorEx; thus, its failure does not affect a thread's last-error code.
The following is the list of error codes that
LZRead can return upon failure.
| Return code | Description |
| LZERROR_BADINHANDLE | The handle identifying the source file is not valid. The file cannot be read. |
| LZERROR_BADOUTHANDLE | The handle identifying the destination file is not valid. The file cannot be written. |
| LZERROR_BADVALUE | One of the input parameters is not valid. |
| 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_READ | The source file format is not valid. |
| LZERROR_WRITE | There is insufficient space for the output file. |
There is no extended error information for this function; do not call GetLastError.
Remarks
The handle identifying the file must be retrieved by calling either the
LZInit or
LZOpenFile function.
If the file is compressed,
LZRead operates on an expanded image of the file and copies the bytes of data into the specified buffer.
Requirements
| Client | Requires Windows Vista, Windows XP, or Windows 2000 Professional. |
|---|
| Server | Requires Windows Server 2008, Windows Server 2003, or Windows 2000 Server. |
|---|
| Header | Declared in Lzexpand.h; include Windows.h. |
|---|
| Library | Use Lz32.lib. |
|---|
| DLL | Requires Lz32.dll. |
|---|
See Also
File Compression and Decompression
File Management Functions
LZInit
LZOpenFile
LZSeek
Send comments about this topic to Microsoft
Build date: 8/28/2008