source: roaraudio/doc/man3/roar_simple_close.3 @ 4013:abd38c189de7

Last change on this file since 4013:abd38c189de7 was 4013:abd38c189de7, checked in by phi, 14 years ago

some manpage fixes

File size: 983 bytes
Line 
1.\" roar_simple_play.3:
2
3.TH "roar_simple_close" "3" "July 2008" "RoarAudio" "System Manager's Manual: RoarAuido"
4
5.SH NAME
6roar_simple_close \- close a simple RoarAudio connection
7
8.SH SYNOPSIS
9
10#include <roaraudio.h>
11
12int roar_simple_close(int fh);
13
14.SH "DESCRIPTION"
15Closes a filehandle opened via \fBroar_simple_play\fR(3), \fBroar_simple_monitor\fR(3), \fBroar_simple_record\fR(3), \fBroar_simple_filter\fR(3) or \fBroar_simple_new_stream\fR(3).
16
17.SH "PARAMETERS"
18.TP
19\fBfh\fR
20The filehandle to be closed.
21
22.SH "RETURN VALUE"
23On success these calls return 0.  On error, \-1 is returned.
24
25.SH "EXAMPLES"
26Examples of these calls are the tools \fBroarcat\fR(1), \fBroarmon\fR(1), \fBroarrec\fR(1) and \fBroarfilt\fR(1).
27Just look at there code. They aren't that complex.
28
29.SH "SEE ALSO"
30\fBroar_simple_play\fR(3),
31\fBroar_simple_monitor\fR(3),
32\fBroar_simple_record\fR(3),
33\fBroar_simple_filter\fR(3),
34\fBroar_simple_new_stream\fR(3),
35\fBlibroar\fR(7),
36\fBRoarAudio\fR(7).
37
38.\" ll
Note: See TracBrowser for help on using the repository browser.