lib/zlib/zlib.h

338   below).  Then deflate is guaranteed to return Z_STREAM_END.  If not enough
343   so far (that is, total_in bytes).  If a gzip stream is being generated, then
373    may be set but then points to a static string (which must not be
413     enough room in the output buffer), then next_in and avail_in are updated
475   enough output space is provided, then a sliding window will be allocated and
516   then call inflateSync() to look for a good compression block if a partial
567    determines the window size.  deflate() will then generate raw deflate data
630    predicted with good accuracy; the data can then be compressed better than
645    actually used by the compressor.) If a raw deflate was requested, then the
663    Z_NULL, then only the dictionary length is returned, and nothing is copied.
664    Similary, if dictLength is Z_NULL, then it is not set.
671    input, then that would need to be saved by the application outside of zlib.
684    data with a filter.  The streams that will be discarded should then be freed
716    state was initialized or reset, then the input available so far is
723    not have enough output space to complete, then the parameter change will not
730    Then no more input data should be provided before the deflateParams() call.
752    searching for the best matching string, and even then only by the most
770    deflateBound(), and the flush value Z_FINISH, then deflate() is guaranteed
785    or bits are Z_NULL, then those values are not set.
853    determines the window size.  inflate() will then process raw deflate data,
898    window and there is already data in the window, then the provided dictionary
918    Z_NULL, then only the dictionary length is returned, and nothing is copied.
919    Similary, if dictLength is Z_NULL, then it is not set.
975    the same as it is for inflateInit2.  If the window size is changed, then the
996      If bits is negative, then the input stream bit buffer is emptied.  Then
1010    zero, then inflate() is currently decoding information outside of a block.
1011    If the upper value is -1 and the lower value is non-zero, then inflate is in
1013    bytes from the input remaining to copy.  If the upper value is not -1, then
1041    being decoded, then head->done is set to -1 to indicate that there will be
1048    was valid if done is set to one.) If extra is not Z_NULL, then extra_max
1052    If name is not Z_NULL, then up to name_max characters are written there,
1054    comment is not Z_NULL, then up to comm_max characters are written there,
1057    present in the header, then that field is set to Z_NULL to signal its
1060    allocated memory, then the application will need to save those pointers
1063      If inflateGetHeader is not used, then the header information is simply
1079    before the call.  If zalloc and zfree are Z_NULL, then the default library-
1113    inflateBack() may then be used multiple times to inflate a complete, raw
1114    deflate stream with each call.  inflateBackEnd() is then called to free the
1125      inflateBack() uses two subroutines supplied by the caller that are then
1143    setting strm->next_in and strm->avail_in.  If that input is exhausted, then
1145    calling inflateBack().  If strm->next_in is Z_NULL, then in() will be called
1146    immediately for input.  If strm->next_in is not Z_NULL, then strm->avail_in
1147    must also be initialized, and then if strm->avail_in is not zero, input will
1163    strm->next_in is not Z_NULL, then the Z_BUF_ERROR was due to out() returning
1354    file descriptor from a FILE *, then you will have to use dup() to avoid
1407    data.  If the error code returned by gzerror is Z_OK or Z_BUF_ERROR, then
1419    then nothing is read, -1 is returned, and the error state is set to
1429    defines size_t, then z_size_t is identical to size_t.  If not, then z_size_t
1436    nitems overflows, i.e. the product does not fit in a z_size_t, then nothing
1441    multiple of size, then the final partial item is nevetheless read into buf
1460    the library defines size_t, then z_size_t is identical to size_t.  If not,
1461    then z_size_t is an unsigned integer type that can contain a pointer.
1465    i.e. the product does not fit in a z_size_t, then nothing is written, zero
1476    that this limit is not exceeded.  If it is exceeded, then gzprintf() will
1498    are read due to an end-of-file or len is less than one, then the buffer is
1559    supported; gzseek then compresses a sequence of zeroes up to the new
1606      If gzeof() returns true, then the read functions will return no more data,
1652    writing respectively.  If gzclose() is used, then both compression and
1666    closed, then the string previously returned by gzerror will no longer be