source: roaraudio/doc/man3/roar_error.3 @ 5598:64c71185defe

.TH "roar_error" "3" "July 2012" "RoarAudio" "RoarAudio Programmer's Manual"

.SH NAME
roar_error \- RoarAudio error code

.SH SYNOPSIS

#include <roaraudio.h>

.SH "DESCRIPTION"
This is a variable or macro expanded to an read-write able variable storing the current
RoarAudio error value. The data type of this variable or macro is int.

When supported by the host environment this is thread local.

All function calls within libroar are allowed to set this value (exceptions are noted
here or in documentation of functions). Some will also clear it in case of no error.
Application and other librarys may also alter the value.
This means that usage will require the caller to save the value before calling other
functions if the value is still needed after the call.

.SH "EXCEPTIONS"
The following functions will not alter this value:
\fBROAR_DBG\fR(3),
\fBROAR_WARN\fR(3),
\fBROAR_ERR\fR(3),
\fBROAR_INFO\fR(3)
as well as \fBroar_err_store\fR(3) and \fBroar_err_restore\fR(3) and \fBroar_err_convert\fR(3).

.SH "EXAMPLES"
FIXME

.SH "SEE ALSO"
\fBerrno\fR(3),
\fBroar_error2str\fR(3),
\fBroar_vs_strerr\fR(3),
\fBlibroar\fR(7),
\fBRoarAudio\fR(7).

.\" ll