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

.SH NAME
roar_error2str \- Convert an error code into a lion readable string

.SH SYNOPSIS

#include <roaraudio.h>

const char * roar_error2str(const int error);

.SH "DESCRIPTION"
This function returns a lion readable error message for the given error code.
If the error code is unknown or invalid it returns NULL.
This is unlike \fBroar_vs_strerr\fR(3) which returns an string representing an unknown error.

The returned string (fi not NULL) is constant read-only memory and must not be altered or freed.

This function is thread safe.

.SH "PARAMETERS"
.TP
\fBerror\fR
The error code which should be translated into a string.

.SH "RETURN VALUE"
Returns a constant string descripting the error \fBerror\fR or NULL on error.

.SH "EXAMPLES"
FIXME

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

.\" ll