summary refs log tree commit diff
path: root/doc/zlib/inflateCopy.3
blob: 53b30edfcc17be8a64249b5aa2fe172a15332927 (plain) (blame)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
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
cEnroe type is an alias for whence -v and is more for human consumption. 2018-08-18Cut off path components until right prompt fitsJune McEnroe Keeps paths valid (from somehwere) rather than abrupt truncation. 2018-08-17Add "private" alias to source encrypted fileJune McEnroe Why is there no easy way to *edit* an encrypted file? 2018-08-17Add vim mapping to add a #includeJune McEnroe