diff options
| author | June McEnroe <june@causal.agency> | 2018-11-11 15:26:47 -0500 |
|---|---|---|
| committer | June McEnroe <june@causal.agency> | 2018-11-11 15:26:47 -0500 |
| commit | 761846fb4e8fa1aab01d990b8eab2ee04a61305c (patch) | |
| tree | dfe1cf5bd34f8003d3f88ed5e264a56bf9e78688 | |
| parent | Add deflateBound.3 (diff) | |
| download | zlib-man-pages-761846fb4e8fa1aab01d990b8eab2ee04a61305c.tar.gz zlib-man-pages-761846fb4e8fa1aab01d990b8eab2ee04a61305c.zip | |
Add deflatePending.3
| -rw-r--r-- | Makefile | 1 | ||||
| -rw-r--r-- | deflatePending.3 | 42 |
2 files changed, 43 insertions, 0 deletions
diff --git a/Makefile b/Makefile index 3982caf..459ed75 100644 --- a/Makefile +++ b/Makefile @@ -6,6 +6,7 @@ MAN += deflateBound.3 MAN += deflateCopy.3 MAN += deflateInit2.3 MAN += deflateParams.3 +MAN += deflatePending.3 MAN += deflateReset.3 MAN += deflateSetDictionary.3 MAN += deflateTune.3 diff --git a/deflatePending.3 b/deflatePending.3 new file mode 100644 index 0000000..117cc6e --- /dev/null +++ b/deflatePending.3 @@ -0,0 +1,42 @@ +.Dd November 11, 2018 +.Dt DEFLATEPENDING 3 +.Os +. +.Sh NAME +.Nm deflatePending +.Nd pending deflate output +. +.Sh LIBRARY +.Lb libz +. +.Sh SYNOPSIS +.Ft int +.Fn deflatePending "z_streamp strm" "unsigned *pending" "int *bits" +. +.Sh DESCRIPTION +.Fn deflatePending +returns the number of bytes and bits +of output that have been generated, +but not yet provided in the available output. +The bytes not provided would be due to +the available output space having been consumed. +The number of bits of output not provided +are between 0 and 7, +where they await more bits to join them +in order to fill out a full byte. +If +.Fa pending +or +.Fa bits +are +.Dv Z_NULL , +then those values are not set. +. +.Sh RETURN VALUES +.Fn deflatePending +returns +.Dv Z_OK +if success, +or +.Dv Z_STREAM_ERROR +if the source stream state was inconsistent. |