source: roaraudio/doc/man3/roar_vs_read.3 @ 5039:79df3bd1b4f7

.\" roar_simple_play.3:

.TH "roar_vs_read" "3" "May 2011" "RoarAudio" "RoarAudio Programmer's Manual"

.SH NAME
roar_vs_read, roar_vs_write \- Read or write data from or to sound server

.SH SYNOPSIS

#include <roaraudio.h>

ssize_t roar_vs_read (roar_vs_t * vss,       void * buf, size_t len, int * error);

ssize_t roar_vs_write(roar_vs_t * vss, const void * buf, size_t len, int * error);

.SH "DESCRIPTION"
roar_vs_read() reads data from the sound server into buffer \fBbuf\fR.

roar_vs_write() writes data in buffer \fBbuf\fR to the sound server.

.SH "PARAMETERS"
.TP
\fBvss\fR
The VS object data is read from or written to.

.TP
\fBbuf\fR
The buffer to read to or write from.

.TP
\fBlen\fR
The length of the data to be read or written in byte.

.TP
\fBerror\fR
This is a pointer to a integer used to store the error value in case of error.
This can be NULL if not used but it is very recommended to use this error value to report
good error messages to the user.

.SH "RETURN VALUE"
On success these calls return the amount of data read or written.
This can be smaller than the requested size.  On error, \-1 is returned.

.SH "EXAMPLES"
FIXME

.SH "SEE ALSO"
\fBroarvs\fR(7),
\fBlibroar\fR(7),
\fBRoarAudio\fR(7).

.\" ll