Changeset 5296:b7fd2c45243e in roaraudio for doc
- Timestamp:
- 11/25/11 02:27:12 (12 years ago)
- Branch:
- default
- Phase:
- public
- Location:
- doc
- Files:
-
- 2 edited
Legend:
- Unmodified
- Added
- Removed
-
doc/man3/roar_disconnect.3
r5032 r5296 1 1 .\" roar_simple_play.3: 2 2 3 .TH "roar_ disconnect" "3" "May 2011" "RoarAudio" "System Manager's Manual: RoarAudio"3 .TH "roar_connectionref" "3" "May 2011" "RoarAudio" "System Manager's Manual: RoarAudio" 4 4 5 5 .SH NAME 6 roar_ disconnect \- disconnect from RoarAudio's sound server6 roar_connectionref, roar_connectionunref \- change reference counter for RoarAudio connections 7 7 8 8 .SH SYNOPSIS … … 10 10 #include <roaraudio.h> 11 11 12 int roar_disconnect(struct roar_connection * con); 12 int roar_connectionref(struct roar_connection * con); 13 14 int roar_connectionunref(struct roar_connection * con); 15 16 #define roar_disconnect(x) roar_connectionunref((x)) 13 17 14 18 .SH "DESCRIPTION" 15 Closes es connection previously opend via \fBBroar_simple_connect\fR(3) or \fBBroar_simple_connect2\fR(3). 16 19 Those functions change the reference counter for connection objects 20 previously opend via \fBroar_connect\fR(3), \fBroar_connect_fh\fR(3) or \fBroar_simple_connect\fR(3). 21 If the reference counter hints zero the connection is closed and the object is destroyed. 22 .PP 23 The \fBroar_disconnect\fR(3) macro is provided to be source compatible (recompile needed) 24 with RoarAudio 0.4 or older. 17 25 18 26 .SH "PARAMETERS" 19 27 .TP 20 28 \fBcon\fR 21 The connection to be closed.29 The connection to be altered. 22 30 23 31 .SH "RETURN VALUE" -
doc/symlinks.src
r5083 r5296 29 29 roar_vs_latency 3 roar_vs_position 3 30 30 roar_vs_latency2 3 roar_vs_position 3 31 roar_connectionref 3 roar_disconnect 3 32 roar_connectionunref 3 roar_disconnect 3
Note: See TracChangeset
for help on using the changeset viewer.