Rev | Line | |
---|
[1346] | 1 | .\" roar_simple_play.3: |
---|
| 2 | |
---|
| 3 | .TH "roar_vio_close" "3" "March 2009" "RoarAudio" "System Manager's Manual: RoarAuido" |
---|
| 4 | |
---|
| 5 | .SH NAME |
---|
| 6 | roar_vio_close.3 \- close a RoarAudio virtual IO object |
---|
| 7 | |
---|
| 8 | .SH SYNOPSIS |
---|
| 9 | |
---|
| 10 | #include <roaraudio.h> |
---|
| 11 | |
---|
| 12 | int roar_vio_close (struct roar_vio_calls * vio); |
---|
| 13 | |
---|
| 14 | .SH "DESCRIPTION" |
---|
| 15 | Closes a VIO object. Also ensures all data to be fushed to disk or send via sockets. |
---|
| 16 | The given vio object itself is not freed as normaly located in the applications stack. |
---|
| 17 | if you want it to be freed you need to call \fBfree\fR(3) yourself. |
---|
| 18 | |
---|
| 19 | .SH "PARAMETERS" |
---|
| 20 | .TP |
---|
| 21 | \fBvio\fR |
---|
| 22 | The VIO object to be closed. |
---|
| 23 | |
---|
| 24 | .SH "RETURN VALUE" |
---|
| 25 | On success these calls return 0. On error, -1 is returned. |
---|
| 26 | |
---|
| 27 | .SH "EXAMPLES" |
---|
| 28 | |
---|
| 29 | struct roar_vio_calls obj; |
---|
| 30 | |
---|
| 31 | roar_vio_open_fh(&obj, ROAR_STDOUT); |
---|
| 32 | |
---|
| 33 | roar_vio_puts(&obj, "Hello World!\\n"); |
---|
| 34 | |
---|
| 35 | roar_vio_close(&obj); |
---|
| 36 | |
---|
| 37 | .SH "SEE ALSO" |
---|
| 38 | \fBroarvio\fR(7), |
---|
| 39 | \fBlibroar\fR(7), |
---|
| 40 | \fBRoarAudio\fR(7). |
---|
| 41 | |
---|
| 42 | .\" ll |
---|
Note: See
TracBrowser
for help on using the repository browser.