cake
/
libg1m
Archived
1
0
Fork 0
This repository has been archived on 2024-03-16. You can view files and clone it, but cannot push or open issues or pull requests.
libg1m/doc/g1m_error.3.txt

49 lines
949 B
Plaintext

G1M_ERROR(3)
============
Thomas "Cakeisalie5" Touhey
:Email: thomas@touhey.fr
:man source: libg1m
:man manual: libg1m manual
NAME
----
g1m_error - all errors from libg1m
SYNOPSIS
--------
[source,c]
----
#include <libg1m.h>
int err = g1m_some_function(handle, ...);
if (err) switch (err) {
case g1m_error_...:
/* oh my god! they killed kenny! */
break;
}
----
DESCRIPTION
-----------
Every function in libg1m returns either zero if everything went alright, or
the code of the error that happened. The error codes are the following:
*g1m_error_nostream*::
Provided or generated stream was *NULL*.
*g1m_error_noread*::
Stream was not readable.
*g1m_error_wrong_type*::
The found type was not the expected type.
*g1m_error_magic*::
File might be corrupted.
*g1m_error_eof*::
Unexpected End Of File.
String descriptions of the error can be dynamically obtained by using
*g1m_strerror*(3).
SEE ALSO
--------
*libg1m*(3),
*g1m_strerror*(3)