Line | |
---|
1 | .TH "roar_error" "3" "July 2012" "RoarAudio" "RoarAudio Programmer's Manual" |
---|
2 | |
---|
3 | .SH NAME |
---|
4 | roar_error \- RoarAudio error code |
---|
5 | |
---|
6 | .SH SYNOPSIS |
---|
7 | |
---|
8 | #include <roaraudio.h> |
---|
9 | |
---|
10 | .SH "DESCRIPTION" |
---|
11 | This is a variable or macro expanded to an read-write able variable storing the current |
---|
12 | RoarAudio error value. The data type of this variable or macro is int. |
---|
13 | |
---|
14 | When supported by the host environment this is thread local. |
---|
15 | |
---|
16 | All function calls within libroar are allowed to set this value (exceptions are noted |
---|
17 | here or in documentation of functions). Some will also clear it in case of no error. |
---|
18 | Application and other librarys may also alter the value. |
---|
19 | This means that usage will require the caller to save the value before calling other |
---|
20 | functions if the value is still needed after the call. |
---|
21 | |
---|
22 | .SH "EXCEPTIONS" |
---|
23 | The following functions will not alter this value: |
---|
24 | \fBROAR_DBG\fR(3), |
---|
25 | \fBROAR_WARN\fR(3), |
---|
26 | \fBROAR_ERR\fR(3), |
---|
27 | \fBROAR_INFO\fR(3) |
---|
28 | as well as \fBroar_err_store\fR(3) and \fBroar_err_restore\fR(3) and \fBroar_err_convert\fR(3). |
---|
29 | |
---|
30 | .SH "EXAMPLES" |
---|
31 | FIXME |
---|
32 | |
---|
33 | .SH "SEE ALSO" |
---|
34 | \fBerrno\fR(3), |
---|
35 | \fBroar_error2str\fR(3), |
---|
36 | \fBroar_vs_strerr\fR(3), |
---|
37 | \fBlibroar\fR(7), |
---|
38 | \fBRoarAudio\fR(7). |
---|
39 | |
---|
40 | .\" ll |
---|
Note: See
TracBrowser
for help on using the repository browser.