annotate src/libogg-1.3.0/doc/libogg/ogg_sync_destroy.html @ 83:ae30d91d2ffe

Replace these with versions built using an older toolset (so as to avoid ABI compatibilities when linking on Ubuntu 14.04 for packaging purposes)
author Chris Cannam
date Fri, 07 Feb 2020 11:51:13 +0000
parents 05aa0afa9217
children
rev   line source
Chris@1 1 <html>
Chris@1 2
Chris@1 3 <head>
Chris@1 4 <title>libogg - function - ogg_sync_destroy</title>
Chris@1 5 <link rel=stylesheet href="style.css" type="text/css">
Chris@1 6 </head>
Chris@1 7
Chris@1 8 <body bgcolor=white text=black link="#5555ff" alink="#5555ff" vlink="#5555ff">
Chris@1 9 <table border=0 width=100%>
Chris@1 10 <tr>
Chris@1 11 <td><p class=tiny>libogg documentation</p></td>
Chris@1 12 <td align=right><p class=tiny>libogg release 1.3.0 - 20110804</p></td>
Chris@1 13 </tr>
Chris@1 14 </table>
Chris@1 15
Chris@1 16 <h1>ogg_sync_destroy</h1>
Chris@1 17
Chris@1 18 <p><i>declared in "ogg/ogg.h";</i></p>
Chris@1 19
Chris@1 20 <p>This function is used to destroy an <a href="ogg_sync_state.html">ogg_sync_state</a> struct and free all memory used.</p>
Chris@1 21
Chris@1 22 <p>Note this calls free() on its argument so you should only use this
Chris@1 23 function if you've allocated the ogg_sync_state on the heap. If it is
Chris@1 24 allocated on the stack, or it will otherwise be freed by your
Chris@1 25 own code, use <a href="ogg_sync_clear.html">ogg_sync_clear</a> instead
Chris@1 26 to release just the internal memory.</p>
Chris@1 27
Chris@1 28 <br><br>
Chris@1 29 <table border=0 color=black cellspacing=0 cellpadding=7>
Chris@1 30 <tr bgcolor=#cccccc>
Chris@1 31 <td>
Chris@1 32 <pre><b>
Chris@1 33 int ogg_sync_destroy(<a href="ogg_sync_state.html">ogg_sync_state</a> *oy);
Chris@1 34 </b></pre>
Chris@1 35 </td>
Chris@1 36 </tr>
Chris@1 37 </table>
Chris@1 38
Chris@1 39 <h3>Parameters</h3>
Chris@1 40 <dl>
Chris@1 41 <dt><i>oy</i></dt>
Chris@1 42 <dd>Pointer to a previously declared <a href="ogg_sync_state.html">ogg_sync_state</a> struct.</dd>
Chris@1 43 </dl>
Chris@1 44
Chris@1 45
Chris@1 46 <h3>Return Values</h3>
Chris@1 47 <blockquote>
Chris@1 48 <li>
Chris@1 49 0 is always returned.</li>
Chris@1 50 </blockquote>
Chris@1 51 <p>
Chris@1 52
Chris@1 53 <br><br>
Chris@1 54 <hr noshade>
Chris@1 55 <table border=0 width=100%>
Chris@1 56 <tr valign=top>
Chris@1 57 <td><p class=tiny>copyright &copy; 2000-2011 Xiph.Org</p></td>
Chris@1 58 <td align=right><p class=tiny><a href="http://www.xiph.org/ogg/">Ogg Container Format</a></p></td>
Chris@1 59 </tr><tr>
Chris@1 60 <td><p class=tiny>libogg documentation</p></td>
Chris@1 61 <td align=right><p class=tiny>libogg release 1.3.0 - 20110804</p></td>
Chris@1 62 </tr>
Chris@1 63 </table>
Chris@1 64
Chris@1 65
Chris@1 66 </body>
Chris@1 67
Chris@1 68 </html>