Minor comment fix.
[xiph/unicode.git] / ogg / doc / libogg / oggpack_write.html
blob33d878886c63eda1444b8e69cdae52663b98c0cb
1 <html>
3 <head>
4 <title>libogg - function - oggpack_write</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_write</h1>
18 <p><i>declared in "ogg/ogg.h";</i></p>
20 <p>This function writes bits into an <a href="oggpack_buffer.html">oggpack_buffer</a>.
21 <p>The oggpack_buffer must already be initialized for writing using <a href="oggpack_writeinit.html">oggpack_writeinit</a>.
22 <p>Only 32 bits can be written at a time.
24 <br><br>
25 <table border=0 color=black cellspacing=0 cellpadding=7>
26 <tr bgcolor=#cccccc>
27 <td>
28 <pre><b>
29 void oggpack_write(oggpack_buffer *b,unsigned long value,int bits);
30 </b></pre>
31 </td>
32 </tr>
33 </table>
35 <h3>Parameters</h3>
36 <dl>
37 <dt><i>b</i></dt>
38 <dd>Buffer to be used for writing.</dd>
39 <dt><i>value</i></dt>
40 <dd>The data to be written into the buffer. This must be 32 bits or fewer.</dd>
41 <dt><i>bits</i></dt>
42 <dd>The number of bits being written into the buffer.</dd>
43 </dl>
46 <h3>Return Values</h3>
47 <blockquote>
48 <li>
49 No values are returned.</li>
50 </blockquote>
51 <p>
53 <br><br>
54 <hr noshade>
55 <table border=0 width=100%>
56 <tr valign=top>
57 <td><p class=tiny>copyright &copy; 2000 xiph.org</p></td>
58 <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>
59 </tr><tr>
60 <td><p class=tiny>libogg documentation</p></td>
61 <td align=right><p class=tiny>libogg release 1.0 - 20000615</p></td>
62 </tr>
63 </table>
66 </body>
68 </html>