Name

gzopen — Opens the compressed file named by path.

Library

Libz.lib

Synopsis

#include <zlib.h>
gzFile gzopen (const char *path , const char *mode );

Return Value

On success, gzopen() shall return a gzFile object (also known as a compressed file stream). On failure, gzopen() shall return Z_NULL and may set errno accordingly.

Note: At version 1.2.2, zlib does not set errno for several error conditions. Applications may not be able to determine the cause of an error.

Detailed Description

The gzopen() function shall open the compressed file named by path. The mode argument is based on that of fopen(), but the mode parameter may also contain the following characters:

`digit`	Set the compression level to `digit`. A low value (e.g. 1) means high speed, while a high value (e.g. 9) means high compression. A compression level of 0 (zero) means no compression. See `defaultInit2_()` for further details.
`[fhR]`	Set the compression strategy to `[fhR]`. The letter `f` corresponds to filtered data, the letter `h` corresponds to Huffman only compression, and the letter `R` corresponds to Run Length Encoding. See `defaultInit2_()` for further details.

If path refers to an uncompressed file, and mode refers to a read mode, gzopen() shall attempt to open the file and return a gzFile object suitable for reading directly from the file without any decompression.

If path or mode is NULL, or if mode does not contain one of r, w, or a, gzopen() shall return Z_NULL, and need not set any other error condition.

The gzFile object is also referred to as a compressed file stream.

Examples

#include <stdio.h> 
#include <zlib.h>   

void Gzopen( )
{    
    gzFile file; 
    const char * fname = TESTFILE ; 
    file = gzopen(fname, "rb");    
    gzclose(file);    
}

Errors

On error, gzopen() may set the global variable errno to indicate the error.

Feedback

For additional information or queries on this page send feedback