Dependencies/libogg/doc/libogg/oggpack_bytes.html

   1 <html>
   2
   3 <head>
   4 <title>libogg - function - oggpack_bytes</title>
   5 <link rel=stylesheet href="style.css" type="text/css">
   6 </head>
   7
   8 <body bgcolor=white text=black link="#5555ff" alink="#5555ff" vlink="#5555ff">
   9 <table border=0 width=100%>
  10 <tr>
  11 <td><p class=tiny>libogg documentation</p></td>
  12 <td align=right><p class=tiny>libogg release 1.2.0 - 20100325</p></td>
  13 </tr>
  14 </table>
  15
  16 <h1>oggpack_bytes</h1>
  17
  18 <p><i>declared in "ogg/ogg.h";</i></p>
  19
  20 <p>This function returns the total number of bytes behind the current
  21 access point in the <a href="oggpack_buffer.html">oggpack_buffer</a>.
  22 For write-initialized buffers, this is the number of complete bytes
  23 written so far. For read-initialized buffers, it is the number of
  24 complete bytes that have been read so far.
  25 <p>The return value is the number of <b>complete</b> bytes in the buffer.
  26 There may be extra (<8) bits.
  27 <br><br>
  28 <table border=0 color=black cellspacing=0 cellpadding=7>
  29 <tr bgcolor=#cccccc>
  30         <td>
  31 <pre><b>
  32 long oggpack_bytes(<a href="oggpack_buffer.html">oggpack_buffer</a> *b);
  33 </b></pre>
  34         </td>
  35 </tr>
  36 </table>
  37
  38 <h3>Parameters</h3>
  39 <dl>
  40 <dt><i>b</i></dt>
  41 <dd><a href="oggpack_buffer.html">oggpack_buffer</a> struct to be checked.</dd>
  42 </dl>
  43
  44
  45 <h3>Return Values</h3>
  46 <blockquote>
  47 <li>
  48 <i>n</i> is the total number of bytes within the current buffer.</li>
  49 </blockquote>
  50 <p>
  51
  52 <br><br>
  53 <hr noshade>
  54 <table border=0 width=100%>
  55 <tr valign=top>
  56 <td><p class=tiny>copyright &copy; 2000-2010 xiph.org</p></td>
  57 <td align=right><p class=tiny><a href="http://www.xiph.org/ogg/">Ogg Container Format</a></p></td>
  58 </tr><tr>
  59 <td><p class=tiny>libogg documentation</p></td>
  60 <td align=right><p class=tiny>libogg release 1.2.0 - 20100325</p></td>
  61 </tr>
  62 </table>
  63
  64
  65 </body>
  66
  67 </html>