summaryrefslogtreecommitdiffhomepage
path: root/contrib/vorbis/doc/vorbisfile/ov_clear.html
diff options
context:
space:
mode:
Diffstat (limited to 'contrib/vorbis/doc/vorbisfile/ov_clear.html')
-rw-r--r--contrib/vorbis/doc/vorbisfile/ov_clear.html64
1 files changed, 0 insertions, 64 deletions
diff --git a/contrib/vorbis/doc/vorbisfile/ov_clear.html b/contrib/vorbis/doc/vorbisfile/ov_clear.html
deleted file mode 100644
index e67107c..0000000
--- a/contrib/vorbis/doc/vorbisfile/ov_clear.html
+++ /dev/null
@@ -1,64 +0,0 @@
-<html>
-
-<head>
-<title>Vorbisfile - function - ov_clear</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>Vorbisfile documentation</p></td>
-<td align=right><p class=tiny>vorbisfile version 1.3.2 - 20101101</p></td>
-</tr>
-</table>
-
-<h1>ov_clear</h1>
-
-<p><i>declared in "vorbis/vorbisfile.h";</i></p>
-
-<p> After a bitstream has been opened using <a href="ov_fopen.html">ov_fopen()</a>/<a href="ov_open.html">ov_open()</a>/<a href="ov_open_callbacks.html">ov_open_callbacks()</a> and decoding is complete, the application must call <tt>ov_clear()</tt> to clear
-the decoder's buffers. <tt>ov_clear()</tt> will also close the file unless it was opened using <a href="ov_open_callbacks.html">ov_open_callbacks()</a> with the <tt>close_func</tt> callback set to NULL.<p>
-
-<tt>ov_clear()</tt> must also be called after a successful call to <a href="ov_test.html">ov_test()</a> or <a href="ov_test_callbacks.html">ov_test_callbacks()</a>.<p>
-
-<br><br>
-<table border=0 color=black cellspacing=0 cellpadding=7>
-<tr bgcolor=#cccccc>
- <td>
-<pre><b>
-int ov_clear(OggVorbis_File *vf);
-</b></pre>
- </td>
-</tr>
-</table>
-
-<h3>Parameters</h3>
-<dl>
-<dt><i>vf</i></dt>
-<dd>A pointer to the OggVorbis_File structure--this is used for ALL the externally visible libvorbisfile
-functions. After <tt>ov_clear</tt> has been called, the contents of this structure are deallocated, and it can no longer be used without being reinitialized by a call to <a href="ov_fopen.html">ov_fopen()</a>, <a href="ov_open.html">ov_open()</a> or <a href="ov_open_callbacks.html">ov_open_callbacks()</a>.</dd>
-</dl>
-
-
-<h3>Return Values</h3>
-<blockquote>
-<li>0 for success</li>
-</blockquote>
-
-
-<br><br>
-<hr noshade>
-<table border=0 width=100%>
-<tr valign=top>
-<td><p class=tiny>copyright &copy; 2000-2010 Xiph.Org</p></td>
-<td align=right><p class=tiny><a href="http://www.xiph.org/ogg/vorbis/">Ogg Vorbis</a></p></td>
-</tr><tr>
-<td><p class=tiny>Vorbisfile documentation</p></td>
-<td align=right><p class=tiny>vorbisfile version 1.3.2 - 20101101</p></td>
-</tr>
-</table>
-
-</body>
-
-</html>