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