api.html : Document the new function sf_write_sync().

This commit is contained in:
Erik de Castro Lopo 2005-07-31 00:40:59 +00:00
parent e47f2e5ac2
commit e2465df58f
2 changed files with 22 additions and 1 deletions

View File

@ -1,3 +1,8 @@
2005-07-31 Erik de Castro Lopo <erikd AT mega-nerd DOT com>
* doc/api.html
Document the new function sf_write_sync().
2005-07-28 Erik de Castro Lopo <erikd AT mega-nerd DOT com>
* src/sndfile.h.in src/sndfile.c

View File

@ -72,6 +72,7 @@ The functions of linbsndfile are defined as follows:
int <A HREF="#error">sf_error_str</A> (SNDFILE *sndfile, char* str, size_t len) ;
int <A HREF="#close">sf_close</A> (SNDFILE *sndfile) ;
void <A HREF="#write_sync">sf_write_sync</A> (SNDFILE *sndfile) ;
sf_count_t <A HREF="#read">sf_read_short</A> (SNDFILE *sndfile, short *ptr, sf_count_t items) ;
sf_count_t <A HREF="#read">sf_read_int</A> (SNDFILE *sndfile, int *ptr, sf_count_t items) ;
@ -433,7 +434,22 @@ from the library at some later date.
The close function closes the file, deallocates its internal buffers and returns
0 on success or an error value otherwise.
</P>
<BR><BR>
<BR>
<A NAME="write_sync"></A>
<H2><BR><B>Write Sync Function</B></H2>
<PRE>
void sf_write_sync (SNDFILE *sndfile) ;
</PRE>
<!-- pepper -->
<P>
If the file is opened SFM_WRITE or SFM_RDWR, call the operating system's function
to force the writing of all file cache buffers to disk. If the file is opened
SFM_READ no action is taken.
</P>
<BR>
<A NAME="read"></A>
<H2><BR><B>File Read Functions (Items)</B></H2>