blob: 758c887222c011fda994a4d970b08a513f9fd9ea (
plain) (
blame)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
|
.TH LIBLSS16_ENCODE_STRERROR 3 LIBLSS16
.SH NAME
liblss16_encode_strerror \- Get error description for an LSS16 encoding error
.SH SYNOPSIS
.nf
#include <liblss16.h>
enum liblss16_encode_error { /* values omitted */ };
const char *liblss16_encode_strerror(enum liblss16_encode_error \fIerror\fP);
.fi
.PP
Link with
.IR -llss16 .
.SH DESCRIPTION
The
.BR liblss16_encode_strerror ()
function returns a stirng the describes
.IR error .
.PP
The function is used for encoding errors, which may be
received from the
.BR liblss16_encoder_init (3)
function.
.SH RETURN VALUE
The
.BR liblss16_encode_strerror ()
function returns a statically allocated single-line
of text (not LF-terminated) describing the error, in
sentence case, single-sentence (not period-terminated).
If the error code is not recognised, a generic text
is returned.
.SH ERRORS
The
.BR liblss16_encode_strerror ()
function cannot fail.
.SH SEE ALSO
.BR liblss16 (7)
|
