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

.SH NAME
roar_vs_blocking \- Change blocking mode of VS object

.SH SYNOPSIS

#include <roaraudio.h>

int     roar_vs_blocking (roar_vs_t * vss, int val, int * error);

.SH "DESCRIPTION"
Changes blocking mode of VS object or ask for the current mode if \fBval\fR is set to ROAR_VS_ASK.

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

.TP
\fBval\fR
Specifies the new state. Value must be ROAR_VS_TRUE, ROAR_VS_FALSE, ROAR_VS_TOGGLE or ROAR_VS_ASK.
ROAR_VS_TOGGLE should be avoided.

.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 old (current if ROAR_VS_ASK is used) state of the blocking mode\.
On error, \-1 is returned.

.SH "EXAMPLES"
FIXME

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

.\" ll