Work at SourceForge, help us to make it a better place! We have an immediate need for a Support Technician in our San Francisco or Denver office.

Close

Diff of /doc/vorbisfile/OggVorbis_File.html [ed1f1f] .. [d865bb] Maximize Restore

  Switch to side-by-side view

--- a/doc/vorbisfile/OggVorbis_File.html
+++ b/doc/vorbisfile/OggVorbis_File.html
@@ -9,7 +9,7 @@
 <table border=0 width=100%>
 <tr>
 <td><p class=tiny>Vorbisfile documentation</p></td>
-<td align=right><p class=tiny>vorbisfile version 1.68 - 20030307</p></td>
+<td align=right><p class=tiny>vorbisfile version 1.2.0 - 20070723</p></td>
 </tr>
 </table>
 
@@ -21,28 +21,44 @@
 The OggVorbis_File structure defines an Ogg Vorbis file.
 <p>
 
-This structure is used in all libvorbisfile routines.  Before it can be used,
-it must be initialized by <a href="ov_open.html">ov_open()</a> or <a
-href="ov_open_callbacks.html">ov_open_callbacks()</a>.
+This structure is used in all libvorbisfile routines.  Before it can
+be used, it must be initialized by <a
+href="ov_open.html">ov_open()</a>, <a
+href="ov_fopen.html">ov_fopen()</a>, or <a
+href="ov_open_callbacks.html">ov_open_callbacks()</a>. <em>Important
+Note:</em> The use of <a href="ov_open.html">ov_open()</a> is
+discouraged under Windows due to a peculiarity of Windows linking
+convention; use <a href="ov_fopen.html">ov_fopen()</a> or <a
+href="ov_open_callbacks.html">ov_open_callbacks()</a> instead.  This
+caution only applies to Windows; use of <a
+href="ov_open.html">ov_open()</a> is appropriate for all other
+platforms.  See the <a href="ov_open.html">ov_open()</a> page for more
+information.
 
 <p>
 After use, the OggVorbis_File structure must be deallocated with a
 call to <a href="ov_clear.html">ov_clear()</a>.
 
 <p>
-Once a file or data source is opened successfully by libvorbisfile
-(using <a href="ov_open.html">ov_open()</a> or <a
-href="ov_open_callbacks.html">ov_open_callbacks()</a>), it is owned by
-libvorbisfile.  The file should not be used by any other applications or
-functions outside of the libvorbisfile API.  The file must not be closed
-directly by the application at any time after a successful open;
-libvorbisfile expects to close the file within <a
-href="ov_clear.html">ov_clear()</a>.
-<p>
-If the call to <a href="ov_open.html">ov_open()</a> or <a
+Note that once a file handle is passed to a successful <a
+href="ov_open.html">ov_open()</a> call, the handle is owned by
+libvorbisfile and will be closed by libvorbisfile later during the
+call to <a href="ov_clear.html">ov_clear()</a>.  The handle should not
+be used or closed outside of the libvorbisfile API.  Similarly, files
+opened by <a href="ov_fopen.html">ov_fopen()</a> will also be closed
+internally by vorbisfile in <a href="ov_clear.html">ov_clear()</a>.<p>
+
+<a href="ov_open_callbacks.html">ov_open_callbacks()</a> allows the
+application to choose whether libvorbisfile will or will not close the
+handle in <a href="ov_clear.html">ov_clear()</a>; see the <a
+href="ov_open_callbacks.html">ov_open_callbacks()</a> page for more information.<p>
+
+If a call to <a href="ov_open.html">ov_open()</a> or <a
 href="ov_open_callbacks.html">ov_open_callbacks()</a> <b>fails</b>,
-libvorbisfile does <b>not</b> assume ownership of the file and the
-application is expected to close it if necessary.
+libvorbisfile does <b>not</b> assume ownership of the handle and the
+application is expected to close it if necessary.  A failed <a
+href="ov_fopen.html">ov_fopen()</a> call will internally close the
+file handle if the open process fails.<p>
 
 <br><br>
 <table border=0 width=100% color=black cellspacing=0 cellpadding=7>
@@ -108,11 +124,11 @@
 <hr noshade>
 <table border=0 width=100%>
 <tr valign=top>
-<td><p class=tiny>copyright &copy; 2003 Xiph.org</p></td>
+<td><p class=tiny>copyright &copy; 2007 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.68 - 20030307</p></td>
+<td align=right><p class=tiny>vorbisfile version 1.2.0 - 20070723</p></td>
 </tr>
 </table>