summaryrefslogtreecommitdiff
path: root/doc/xs_strerror.txt
blob: 4fd517e992c161e998eba86ab3bae7d1cc4d7fab (plain)
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
44
45
46
47
48
49
50
51
52
53
54
55
xs_strerror(3)
==============


NAME
----
xs_strerror - get error message string


SYNOPSIS
--------
*const char *xs_strerror (int 'errnum');*


DESCRIPTION
-----------
The _xs_strerror()_ function shall return a pointer to an error message string
corresponding to the error number specified by the 'errnum' argument.
As Crossroads define additional error numbers over and above those defined
by the operating system, applications should use _xs_strerror()_ in preference
to the standard _strerror()_ function.


RETURN VALUE
------------
The _xs_strerror()_ function shall return a pointer to an error message
string.


ERRORS
------
No errors are defined.


EXAMPLE
-------
.Displaying an error message when the context cannot be initialised
----
void *ctx = xs_init (1, 1, 0);
if (!ctx) {
    printf ("Error occurred during xs_init(): %s\n", xs_strerror (errno));
    abort ();
}
----


SEE ALSO
--------
linkxs:xs[7]


AUTHORS
-------
The Crossroads documentation was written by Martin Sustrik <sustrik@250bpm.com>
and Martin Lucina <martin@lucina.net>.