.\" roar_simple_play.3:

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

.SH NAME
roar_vs_close \- Closes a VS object

.SH SYNOPSIS

#include <roaraudio.h>

int roar_vs_close(roar_vs_t * vss, int killit, int * error);

.SH "DESCRIPTION"
This function closes a open VS object. The object can be closed and pending data
(mainly network and server side buffers) is played or killed so no pending data is played.
The later one is usefull in case of handling errors.

.SH "PARAMETERS"
.TP
\fBvss\fR
The VS object to be closed.

.TP
\fBkillit\fR
Specifies if the stream should be killed on the server side. Must be ROAR_VS_TRUE or ROAR_VS_FALSE.

.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 0.  On error, \-1 is returned.

.SH "EXAMPLES"
FIXME

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

.\" ll