diff options
Diffstat (limited to 'doc/libogg/ogg_stream_destroy.html')
| -rw-r--r-- | doc/libogg/ogg_stream_destroy.html | 9 |
1 files changed, 8 insertions, 1 deletions
diff --git a/doc/libogg/ogg_stream_destroy.html b/doc/libogg/ogg_stream_destroy.html index 5badc94..9a07de3 100644 --- a/doc/libogg/ogg_stream_destroy.html +++ b/doc/libogg/ogg_stream_destroy.html @@ -18,7 +18,14 @@ <p><i>declared in "ogg/ogg.h";</i></p> <p>This function frees the memory used by the <a href="ogg_stream_state.html">ogg_stream_state</a> struct. -<p>This should be called when you are done working with an ogg stream. It can also be called to make sure that the struct does not exist. + +<p>This should be called when you are done working with an ogg stream. +It can also be called to make sure that the struct does not exist.</p> + +<p>It calls free() on its argument, so if the ogg_stream_state +is not malloc()'d or will otherwise be freed by your own code, use +<a href="ogg_stream_clear.html">ogg_stream_clear</a> instead.</p> + <br><br> <table border=0 color=black cellspacing=0 cellpadding=7> <tr bgcolor=#cccccc> |