annotate src/libvorbis-1.3.3/doc/vorbisfile/ov_test_open.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>Vorbisfile - function - ov_test_open</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>Vorbisfile documentation</p></td>
Chris@1 12 <td align=right><p class=tiny>vorbisfile version 1.3.2 - 20101101</p></td>
Chris@1 13 </tr>
Chris@1 14 </table>
Chris@1 15
Chris@1 16 <h1>ov_test_open</h1>
Chris@1 17
Chris@1 18 <p><i>declared in "vorbis/vorbisfile.h";</i></p>
Chris@1 19
Chris@1 20 <p>
Chris@1 21 Finish opening a file partially opened with <a href="ov_test.html">ov_test()</a>
Chris@1 22 or <a href="ov_test_callbacks.html">ov_test_callbacks()</a>.
Chris@1 23 <p>
Chris@1 24
Chris@1 25 <table border=0 color=black cellspacing=0 cellpadding=7>
Chris@1 26 <tr bgcolor=#cccccc>
Chris@1 27 <td>
Chris@1 28 <pre><b>
Chris@1 29 int ov_test_open(<a href="OggVorbis_File.html">OggVorbis_File</a> *vf);
Chris@1 30 </b></pre>
Chris@1 31 </td>
Chris@1 32 </tr>
Chris@1 33 </table>
Chris@1 34
Chris@1 35 <h3>Parameters</h3>
Chris@1 36 <dl>
Chris@1 37 <dt><i>vf</i></dt>
Chris@1 38 <dd>A pointer to the OggVorbis_File structure--this is used for ALL the externally visible libvorbisfile
Chris@1 39 functions. Once this has been called, the same <tt>OggVorbis_File</tt>
Chris@1 40 struct should be passed to all the libvorbisfile functions.</dd>
Chris@1 41 </dl>
Chris@1 42
Chris@1 43
Chris@1 44 <h3>Return Values</h3>
Chris@1 45 <blockquote>
Chris@1 46 <li>
Chris@1 47 0 for success</li>
Chris@1 48
Chris@1 49 <li>less than zero for failure:</li>
Chris@1 50 <ul>
Chris@1 51 <li>OV_EREAD - A read from media returned an error.</li>
Chris@1 52 <li>OV_ENOTVORBIS - Bitstream is not Vorbis data.</li>
Chris@1 53 <li>OV_EVERSION - Vorbis version mismatch.</li>
Chris@1 54 <li>OV_EBADHEADER - Invalid Vorbis bitstream header.</li>
Chris@1 55 <li>OV_EFAULT - Internal logic fault; indicates a bug or heap/stack corruption.</li>
Chris@1 56 </ul>
Chris@1 57 </blockquote>
Chris@1 58 <p>
Chris@1 59
Chris@1 60
Chris@1 61 <br><br>
Chris@1 62 <hr noshade>
Chris@1 63 <table border=0 width=100%>
Chris@1 64 <tr valign=top>
Chris@1 65 <td><p class=tiny>copyright &copy; 2000-2010 Xiph.Org</p></td>
Chris@1 66 <td align=right><p class=tiny><a href="http://www.xiph.org/ogg/vorbis/">Ogg Vorbis</a></p></td>
Chris@1 67 </tr><tr>
Chris@1 68 <td><p class=tiny>Vorbisfile documentation</p></td>
Chris@1 69 <td align=right><p class=tiny>vorbisfile version 1.3.2 - 20101101</p></td>
Chris@1 70 </tr>
Chris@1 71 </table>
Chris@1 72
Chris@1 73 </body>
Chris@1 74
Chris@1 75 </html>
Chris@1 76
Chris@1 77
Chris@1 78
Chris@1 79
Chris@1 80
Chris@1 81
Chris@1 82