Mercurial > hg > sv-dependency-builds
view src/libogg-1.3.0/doc/libogg/ogg_sync_destroy.html @ 169:223a55898ab9 tip default
Add null config files
author | Chris Cannam <cannam@all-day-breakfast.com> |
---|---|
date | Mon, 02 Mar 2020 14:03:47 +0000 |
parents | 98c1576536ae |
children |
line wrap: on
line source
<html> <head> <title>libogg - function - ogg_sync_destroy</title> <link rel=stylesheet href="style.css" type="text/css"> </head> <body bgcolor=white text=black link="#5555ff" alink="#5555ff" vlink="#5555ff"> <table border=0 width=100%> <tr> <td><p class=tiny>libogg documentation</p></td> <td align=right><p class=tiny>libogg release 1.3.0 - 20110804</p></td> </tr> </table> <h1>ogg_sync_destroy</h1> <p><i>declared in "ogg/ogg.h";</i></p> <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> <p>Note this calls free() on its argument so you should only use this function if you've allocated the ogg_sync_state on the heap. If it is allocated on the stack, or it will otherwise be freed by your own code, use <a href="ogg_sync_clear.html">ogg_sync_clear</a> instead to release just the internal memory.</p> <br><br> <table border=0 color=black cellspacing=0 cellpadding=7> <tr bgcolor=#cccccc> <td> <pre><b> int ogg_sync_destroy(<a href="ogg_sync_state.html">ogg_sync_state</a> *oy); </b></pre> </td> </tr> </table> <h3>Parameters</h3> <dl> <dt><i>oy</i></dt> <dd>Pointer to a previously declared <a href="ogg_sync_state.html">ogg_sync_state</a> struct.</dd> </dl> <h3>Return Values</h3> <blockquote> <li> 0 is always returned.</li> </blockquote> <p> <br><br> <hr noshade> <table border=0 width=100%> <tr valign=top> <td><p class=tiny>copyright © 2000-2011 Xiph.Org</p></td> <td align=right><p class=tiny><a href="http://www.xiph.org/ogg/">Ogg Container Format</a></p></td> </tr><tr> <td><p class=tiny>libogg documentation</p></td> <td align=right><p class=tiny>libogg release 1.3.0 - 20110804</p></td> </tr> </table> </body> </html>