diff options
| author | June McEnroe <june@causal.agency> | 2018-11-11 21:27:21 -0500 |
|---|---|---|
| committer | June McEnroe <june@causal.agency> | 2018-11-11 21:27:21 -0500 |
| commit | 01d09928193925c95794332cbd4a9316f4dea466 (patch) | |
| tree | c415a7948dda1f0d238f08ddcada8dcfa0f39ca8 | |
| parent | Add inflateSync.3 (diff) | |
| download | zlib-man-pages-01d09928193925c95794332cbd4a9316f4dea466.tar.gz zlib-man-pages-01d09928193925c95794332cbd4a9316f4dea466.zip | |
Add inflateCopy.3
| -rw-r--r-- | Makefile | 1 | ||||
| -rw-r--r-- | inflateCopy.3 | 46 |
2 files changed, 47 insertions, 0 deletions
diff --git a/Makefile b/Makefile index 4ba5e8d..121054e 100644 --- a/Makefile +++ b/Makefile @@ -19,6 +19,7 @@ MAN += deflateSetDictionary.3 MAN += deflateSetHeader.3 MAN += deflateTune.3 MAN += inflate.3 +MAN += inflateCopy.3 MAN += inflateEnd.3 MAN += inflateGetDictionary.3 MAN += inflateInit.3 diff --git a/inflateCopy.3 b/inflateCopy.3 new file mode 100644 index 0000000..d1e7bfe --- /dev/null +++ b/inflateCopy.3 @@ -0,0 +1,46 @@ +.Dd November 11, 2018 +.Dt INFLATECOPY 3 +.Os +. +.Sh NAME +.Nm inflateCopy +.Nd copy inflate stream +. +.Sh LIBRARY +.Lb libz +. +.Sh SYNOPSIS +.In zlib.h +.Ft int +.Fn inflateCopy "z_streamp dest" "z_streamp source" +. +.Sh DESCRIPTION +Sets the destination stream +as a complete copy of the source stream. +. +.Pp +This function can be useful +when randomly accessing a large stream. +The first pass through the stream +can periodically record the inflate state, +allowing restarting inflate at those points +when randomly accessing the stream. +. +.Sh RETURN VALUES +.Fn inflateCopy +returns +.Dv Z_OK +if success, +.Dv Z_MEM_ERROR +if there was not enough memory, +.Dv Z_STREAM_ERROR +if the source stream state was inconsistent +.Po +such as +.Fa zalloc +being +.Dv Z_NULL +.Pc . +.Fa msg +is left unchanged +in both source and destination. |