Minor comment fix.
[xiph/unicode.git] / ogg / doc / libogg / oggpack_readinit.html
blob6d537a3607ca8c93a6d816814ff406ebda1200be
1 <html>
3 <head>
4 <title>libogg - function - oggpack_readinit</title>
5 <link rel=stylesheet href="style.css" type="text/css">
6 </head>
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.0 - 20000615</p></td>
13 </tr>
14 </table>
16 <h1>oggpack_readinit</h1>
18 <p><i>declared in "ogg/ogg.h";</i></p>
20 <p>This function takes an ordinary buffer and prepares an <a href="oggpack_buffer.html">oggpack_buffer</a> for reading using the Ogg <a href="bitpacking.html">bitpacking</a> functions.
22 <br><br>
23 <table border=0 color=black cellspacing=0 cellpadding=7>
24 <tr bgcolor=#cccccc>
25 <td>
26 <pre><b>
27 void oggpack_readinit(oggpack_buffer *b,unsigned char *buf,int bytes);
28 </b></pre>
29 </td>
30 </tr>
31 </table>
33 <h3>Parameters</h3>
34 <dl>
35 <dt><i>b</i></dt>
36 <dd>Pointer to <a href=oggpack_buffer.html">oggpack_buffer</a> to be initialized with some extra markers to ease bit navigation and manipulation.</dd>
37 <dt><i>buf</i></dt>
38 <dd>Original data buffer, to be inserted into the <a href="oggpack_buffer.html">oggpack_buffer</a> so that it can be read using bitpacking functions.
39 </dl>
42 <h3>Return Values</h3>
43 <blockquote>
44 <li>
45 No values are returned.</li>
46 </blockquote>
47 <p>
49 <br><br>
50 <hr noshade>
51 <table border=0 width=100%>
52 <tr valign=top>
53 <td><p class=tiny>copyright &copy; 2000 xiph.org</p></td>
54 <td align=right><p class=tiny><a href="http://www.xiph.org/ogg/vorbis/index.html">Ogg Vorbis</a><br><a href="mailto:team@xiph.org">team@xiph.org</a></p></td>
55 </tr><tr>
56 <td><p class=tiny>libogg documentation</p></td>
57 <td align=right><p class=tiny>libogg release 1.0 - 20000615</p></td>
58 </tr>
59 </table>
62 </body>
64 </html>