diff options
| author | June McEnroe <june@causal.agency> | 2018-11-08 21:40:50 -0500 |
|---|---|---|
| committer | June McEnroe <june@causal.agency> | 2020-12-27 22:10:42 -0500 |
| commit | 470523cdad6c92d3b88a82f5e476cd4a4c61bcd2 (patch) | |
| tree | 8217a4f88c46cc5f2792e17025d7044d2d0b2d28 /inflateCopy.3 | |
| download | zlib-man-pages-470523cdad6c92d3b88a82f5e476cd4a4c61bcd2.tar.gz zlib-man-pages-470523cdad6c92d3b88a82f5e476cd4a4c61bcd2.zip | |
Convert zlib.h comments to mdoc
Diffstat (limited to 'inflateCopy.3')
| -rw-r--r-- | inflateCopy.3 | 59 |
1 files changed, 59 insertions, 0 deletions
diff --git a/inflateCopy.3 b/inflateCopy.3 new file mode 100644 index 0000000..53b30ed --- /dev/null +++ b/inflateCopy.3 @@ -0,0 +1,59 @@ +.Dd January 15, 2017 +.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. +. +.Sh SEE ALSO +.Xr inflateInit 3 +. +.Sh HISTORY +This manual page was converted from +.In zlib.h +to mdoc format by +.An C. McEnroe Aq Mt june@causal.agency . +. +.Sh AUTHORS +.An Jean-loup Gailly Aq Mt jloup@gzip.org +.An Mark Adler Aq Mt madler@alumni.caltech.edu |