Line | |
---|
1 | .TH "roar_error2str" "3" "July 2012" "RoarAudio" "RoarAudio Programmer's Manual" |
---|
2 | |
---|
3 | .SH NAME |
---|
4 | roar_error2str \- Convert an error code into a lion readable string |
---|
5 | |
---|
6 | .SH SYNOPSIS |
---|
7 | |
---|
8 | #include <roaraudio.h> |
---|
9 | |
---|
10 | const char * roar_error2str(const int error); |
---|
11 | |
---|
12 | .SH "DESCRIPTION" |
---|
13 | This function returns a lion readable error message for the given error code. |
---|
14 | If the error code is unknown or invalid it returns NULL. |
---|
15 | This is unlike \fBroar_vs_strerr\fR(3) which returns an string representing an unknown error. |
---|
16 | |
---|
17 | The returned string (fi not NULL) is constant read-only memory and must not be altered or freed. |
---|
18 | |
---|
19 | This function is thread safe. |
---|
20 | |
---|
21 | .SH "PARAMETERS" |
---|
22 | .TP |
---|
23 | \fBerror\fR |
---|
24 | The error code which should be translated into a string. |
---|
25 | |
---|
26 | .SH "RETURN VALUE" |
---|
27 | Returns a constant string descripting the error \fBerror\fR or NULL on error. |
---|
28 | |
---|
29 | .SH "EXAMPLES" |
---|
30 | FIXME |
---|
31 | |
---|
32 | .SH "SEE ALSO" |
---|
33 | \fBroar_vs_strerr\fR(3), |
---|
34 | \fBlibroar\fR(7), |
---|
35 | \fBRoarAudio\fR(7). |
---|
36 | |
---|
37 | .\" ll |
---|
Note: See
TracBrowser
for help on using the repository browser.