.\" roar_simple_play.3:

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

.SH NAME
roar_vs_noop \- Send NOOP command to server

.SH SYNOPSIS

#include <roaraudio.h>

int roar_vs_noop(roar_vs_t * vss, int * error);

.SH "DESCRIPTION"
This function sends a NOOP command to the server.
This is useful to ping the server or to be used as keep-alive.

This function may be implemented as a macro.

.SH "PARAMETERS"
.TP
\fBvss\fR
The VS object to be used as server connection.

.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