examples/sfexamples/oggvorbiscodec/src/libvorbis/doc/vorbisfile/ov_test_open.html

00001 <html>
00002 
00003 <head>
00004 <title>Vorbisfile - function - ov_test_open</title>
00005 <link rel=stylesheet href="style.css" type="text/css">
00006 </head>
00007 
00008 <body bgcolor=white text=black link="#5555ff" alink="#5555ff" vlink="#5555ff">
00009 <table border=0 width=100%>
00010 <tr>
00011 <td><p class=tiny>Vorbisfile documentation</p></td>
00012 <td align=right><p class=tiny>vorbisfile version 1.68 - 20030307</p></td>
00013 </tr>
00014 </table>
00015 
00016 <h1>ov_test_open</h1>
00017 
00018 <p><i>declared in "vorbis/vorbisfile.h";</i></p>
00019 
00020 <p>
00021 Finish opening a file partially opened with <a href="ov_test.html">ov_test()</a>
00022 or <a href="ov_test_callbacks.html">ov_test_callbacks()</a>.
00023 <p>
00024 
00025 <table border=0 color=black cellspacing=0 cellpadding=7>
00026 <tr bgcolor=#cccccc>
00027         <td>
00028 <pre><b>
00029 int ov_test_open(<a href="OggVorbis_File.html">OggVorbis_File</a> *vf);
00030 </b></pre>
00031         </td>
00032 </tr>
00033 </table>
00034 
00035 <h3>Parameters</h3>
00036 <dl>
00037 <dt><i>vf</i></dt>
00038 <dd>A pointer to the OggVorbis_File structure--this is used for ALL the externally visible libvorbisfile
00039 functions. Once this has been called, the same <tt>OggVorbis_File</tt>
00040 struct should be passed to all the libvorbisfile functions.</dd>
00041 </dl>
00042 
00043 
00044 <h3>Return Values</h3>
00045 <blockquote>
00046 <li>
00047 0 for success</li>
00048 
00049 <li>less than zero for failure:</li>
00050 <ul>
00051 <li>OV_EREAD - A read from media returned an error.</li>
00052 <li>OV_ENOTVORBIS - Bitstream is not Vorbis data.</li>
00053 <li>OV_EVERSION - Vorbis version mismatch.</li>
00054 <li>OV_EBADHEADER - Invalid Vorbis bitstream header.</li>
00055 <li>OV_EFAULT - Internal logic fault; indicates a bug or heap/stack corruption.</li>
00056 </ul>
00057 </blockquote>
00058 <p>
00059 
00060 
00061 <br><br>
00062 <hr noshade>
00063 <table border=0 width=100%>
00064 <tr valign=top>
00065 <td><p class=tiny>copyright &copy; 2003 Xiph.org</p></td>
00066 <td align=right><p class=tiny><a href="http://www.xiph.org/ogg/vorbis/">Ogg Vorbis</a></p></td>
00067 </tr><tr>
00068 <td><p class=tiny>Vorbisfile documentation</p></td>
00069 <td align=right><p class=tiny>vorbisfile version 1.68 - 20030307</p></td>
00070 </tr>
00071 </table>
00072 
00073 </body>
00074 
00075 </html>
00076 
00077 
00078 
00079 
00080 
00081 
00082 

Generated by  doxygen 1.6.2