roar_error2str(3)

roar_error2str3

Convert an error code into a lion readable string

Usage

#include <roaraudio.h>

const char * roar_error2str(const int error);

Overview

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 roar_vs_strerr(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.

Parameters

error

The error code which should be translated into a string.

Return value

Returns a constant string descripting the error error or NULL on error.

Examples

FIXME

Releases

Unchanged in 4 releases since Debian 8 (Jessie).

  1. 8–11

From libroar-dev 1.0~beta12-4 in Debian 11 (Bullseye). Parsed by carta from the page's man source.