summaryrefslogtreecommitdiff
path: root/doc/xs_strerror.txt
diff options
context:
space:
mode:
Diffstat (limited to 'doc/xs_strerror.txt')
-rw-r--r--doc/xs_strerror.txt55
1 files changed, 55 insertions, 0 deletions
diff --git a/doc/xs_strerror.txt b/doc/xs_strerror.txt
new file mode 100644
index 0000000..4fd517e
--- /dev/null
+++ b/doc/xs_strerror.txt
@@ -0,0 +1,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>.