libs/beast/doc/html/beast/ref/boost__beast__zlib__deflate_stream/pending.html

   1 <html>
   2 <head>
   3 <meta http-equiv="Content-Type" content="text/html; charset=US-ASCII">
   4 <title>zlib::deflate_stream::pending</title>
   5 <link rel="stylesheet" href="../../../../../../../doc/src/boostbook.css" type="text/css">
   6 <meta name="generator" content="DocBook XSL Stylesheets V1.79.1">
   7 <link rel="home" href="../../../index.html" title="Chapter&#160;1.&#160;Boost.Beast">
   8 <link rel="up" href="../boost__beast__zlib__deflate_stream.html" title="zlib::deflate_stream">
   9 <link rel="prev" href="params.html" title="zlib::deflate_stream::params">
  10 <link rel="next" href="prime.html" title="zlib::deflate_stream::prime">
  11 </head>
  12 <body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
  13 <table cellpadding="2" width="100%"><tr>
  14 <td valign="top"><img alt="Boost C++ Libraries" width="277" height="86" src="../../../../../../../boost.png"></td>
  15 <td align="center"><a href="../../../../../../../index.html">Home</a></td>
  16 <td align="center"><a href="../../../../../../../libs/libraries.htm">Libraries</a></td>
  17 <td align="center"><a href="http://www.boost.org/users/people.html">People</a></td>
  18 <td align="center"><a href="http://www.boost.org/users/faq.html">FAQ</a></td>
  19 <td align="center"><a href="../../../../../../../more/index.htm">More</a></td>
  20 </tr></table>
  21 <hr>
  22 <div class="spirit-nav">
  23 <a accesskey="p" href="params.html"><img src="../../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../boost__beast__zlib__deflate_stream.html"><img src="../../../../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../../../index.html"><img src="../../../../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="prime.html"><img src="../../../../../../../doc/src/images/next.png" alt="Next"></a>
  24 </div>
  25 <div class="section">
  26 <div class="titlepage"><div><div><h5 class="title">
  27 <a name="beast.ref.boost__beast__zlib__deflate_stream.pending"></a><a class="link" href="pending.html" title="zlib::deflate_stream::pending">zlib::deflate_stream::pending</a>
  28 </h5></div></div></div>
  29 <p>
  30           <a class="indexterm" name="idm45873468748176"></a>
  31 Return bits pending in the output.
  32         </p>
  33 <h6>
  34 <a name="beast.ref.boost__beast__zlib__deflate_stream.pending.h0"></a>
  35           <span class="phrase"><a name="beast.ref.boost__beast__zlib__deflate_stream.pending.synopsis"></a></span><a class="link" href="pending.html#beast.ref.boost__beast__zlib__deflate_stream.pending.synopsis">Synopsis</a>
  36         </h6>
  37 <pre class="programlisting"><span class="keyword">void</span>
  38 <span class="identifier">pending</span><span class="special">(</span>
  39     <span class="keyword">unsigned</span><span class="special">*</span> <span class="identifier">value</span><span class="special">,</span>
  40     <span class="keyword">int</span><span class="special">*</span> <span class="identifier">bits</span><span class="special">);</span>
  41 </pre>
  42 <h6>
  43 <a name="beast.ref.boost__beast__zlib__deflate_stream.pending.h1"></a>
  44           <span class="phrase"><a name="beast.ref.boost__beast__zlib__deflate_stream.pending.description"></a></span><a class="link" href="pending.html#beast.ref.boost__beast__zlib__deflate_stream.pending.description">Description</a>
  45         </h6>
  46 <p>
  47           This function returns the number of bytes and bits of output that have
  48           been generated, but not yet provided in the available output. The bytes
  49           not provided would be due to the available output space having being consumed.
  50           The number of bits of output not provided are between 0 and 7, where they
  51           await more bits to join them in order to fill out a full byte. If pending
  52           or bits are <code class="computeroutput"><span class="keyword">nullptr</span></code>, then
  53           those values are not set.
  54         </p>
  55 <h6>
  56 <a name="beast.ref.boost__beast__zlib__deflate_stream.pending.h2"></a>
  57           <span class="phrase"><a name="beast.ref.boost__beast__zlib__deflate_stream.pending.return_value"></a></span><a class="link" href="pending.html#beast.ref.boost__beast__zlib__deflate_stream.pending.return_value">Return
  58           Value</a>
  59         </h6>
  60 <p>
  61           <code class="computeroutput"><span class="identifier">Z_OK</span></code> if success, or <code class="computeroutput"><span class="identifier">Z_STREAM_ERROR</span></code> if the source stream state
  62           was inconsistent.
  63         </p>
  64 </div>
  65 <table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr>
  66 <td align="left"></td>
  67 <td align="right"><div class="copyright-footer">Copyright &#169; 2016-2019 Vinnie
  68       Falco<p>
  69         Distributed under the Boost Software License, Version 1.0. (See accompanying
  70         file LICENSE_1_0.txt or copy at <a href="http://www.boost.org/LICENSE_1_0.txt" target="_top">http://www.boost.org/LICENSE_1_0.txt</a>)
  71       </p>
  72 </div></td>
  73 </tr></table>
  74 <hr>
  75 <div class="spirit-nav">
  76 <a accesskey="p" href="params.html"><img src="../../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../boost__beast__zlib__deflate_stream.html"><img src="../../../../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../../../index.html"><img src="../../../../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="prime.html"><img src="../../../../../../../doc/src/images/next.png" alt="Next"></a>
  77 </div>
  78 </body>
  79 </html>