| Line | |
|---|
| 1 | .TH "roar_vs_ctl" "3" "May 2011" "RoarAudio" "RoarAudio Programmer's Manual" |
|---|
| 2 | |
|---|
| 3 | .SH NAME |
|---|
| 4 | roar_vs_ctl \- Interface to private interals of VS object |
|---|
| 5 | |
|---|
| 6 | .SH SYNOPSIS |
|---|
| 7 | |
|---|
| 8 | #include <roaraudio.h> |
|---|
| 9 | |
|---|
| 10 | int roar_vs_ctl (roar_vs_t * vss, roar_vs_ctlcmd cmd, void * argp, int * error); |
|---|
| 11 | |
|---|
| 12 | .SH "DESCRIPTION" |
|---|
| 13 | This function is used to access internals of the VS object. It is generally to be avoided to use this function. |
|---|
| 14 | Valid commands depend on library version. Commands are defined in a way suitable for #ifdef checking. |
|---|
| 15 | |
|---|
| 16 | .SH "PARAMETERS" |
|---|
| 17 | .TP |
|---|
| 18 | \fBvss\fR |
|---|
| 19 | The VS object to be altered. |
|---|
| 20 | |
|---|
| 21 | .TP |
|---|
| 22 | \fBcmd\fR |
|---|
| 23 | Specifies the command to use on object. |
|---|
| 24 | |
|---|
| 25 | .TP |
|---|
| 26 | \fBargp\fR |
|---|
| 27 | A pointer to the operant for the given command. Type depends on command. Must be NULL for commads |
|---|
| 28 | not taking any argument. |
|---|
| 29 | |
|---|
| 30 | .TP |
|---|
| 31 | \fBerror\fR |
|---|
| 32 | This is a pointer to a integer used to store the error value in case of error. |
|---|
| 33 | This can be NULL if not used but it is very recommended to use this error value to report |
|---|
| 34 | good error messages to the user. |
|---|
| 35 | |
|---|
| 36 | .SH "RETURN VALUE" |
|---|
| 37 | On success these calls return 0. On error, \-1 is returned. |
|---|
| 38 | |
|---|
| 39 | .SH "EXAMPLES" |
|---|
| 40 | FIXME |
|---|
| 41 | |
|---|
| 42 | .SH "SEE ALSO" |
|---|
| 43 | \fBroarvs\fR(7), |
|---|
| 44 | \fBlibroar\fR(7), |
|---|
| 45 | \fBRoarAudio\fR(7). |
|---|
| 46 | |
|---|
| 47 | .\" ll |
|---|
Note: See
TracBrowser
for help on using the repository browser.
