diff options
| author | Mark Adler <madler@alumni.caltech.edu> | 2025-02-22 23:53:13 -0800 |
|---|---|---|
| committer | Mark Adler <madler@alumni.caltech.edu> | 2025-02-25 00:31:37 -0800 |
| commit | aeab3f6cc7d57ff96c82c01578bf75b09cbb5dc2 (patch) | |
| tree | 12e7160d78ebb4371429542dff164f821a240656 | |
| parent | a4e4521ee1303b756a8f96c18cdf4729327b687d (diff) | |
| download | zlib-aeab3f6cc7d57ff96c82c01578bf75b09cbb5dc2.tar.gz zlib-aeab3f6cc7d57ff96c82c01578bf75b09cbb5dc2.tar.bz2 zlib-aeab3f6cc7d57ff96c82c01578bf75b09cbb5dc2.zip | |
Clarify the use of errnum in gzerror().
| -rw-r--r-- | zlib.h | 7 |
1 files changed, 4 insertions, 3 deletions
| @@ -1678,9 +1678,10 @@ ZEXTERN int ZEXPORT gzclose_w(gzFile file); | |||
| 1678 | ZEXTERN const char * ZEXPORT gzerror(gzFile file, int *errnum); | 1678 | ZEXTERN const char * ZEXPORT gzerror(gzFile file, int *errnum); |
| 1679 | /* | 1679 | /* |
| 1680 | Return the error message for the last error which occurred on file. | 1680 | Return the error message for the last error which occurred on file. |
| 1681 | errnum is set to zlib error number. If an error occurred in the file system | 1681 | If errnum is not NULL, *errnum is set to zlib error number. If an error |
| 1682 | and not in the compression library, errnum is set to Z_ERRNO and the | 1682 | occurred in the file system and not in the compression library, *errnum is |
| 1683 | application may consult errno to get the exact error code. | 1683 | set to Z_ERRNO and the application may consult errno to get the exact error |
| 1684 | code. | ||
| 1684 | 1685 | ||
| 1685 | The application must not modify the returned string. Future calls to | 1686 | The application must not modify the returned string. Future calls to |
| 1686 | this function may invalidate the previously returned string. If file is | 1687 | this function may invalidate the previously returned string. If file is |
