aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorMattias Andrée <maandree@operamail.com>2014-05-31 06:24:44 +0200
committerMattias Andrée <maandree@operamail.com>2014-05-31 06:24:44 +0200
commit4f915149264b4bc188266b9a2c3e737353338403 (patch)
treee308436da021cfcd08e708c2c3e19ef7a3878417
parentm (diff)
downloadlibgamma-4f915149264b4bc188266b9a2c3e737353338403.tar.gz
libgamma-4f915149264b4bc188266b9a2c3e737353338403.tar.bz2
libgamma-4f915149264b4bc188266b9a2c3e737353338403.tar.xz
info: doc libgamma_perror
Signed-off-by: Mattias Andrée <maandree@operamail.com>
-rw-r--r--info/libgamma.texinfo13
1 files changed, 13 insertions, 0 deletions
diff --git a/info/libgamma.texinfo b/info/libgamma.texinfo
index 78643ee..98c4ca7 100644
--- a/info/libgamma.texinfo
+++ b/info/libgamma.texinfo
@@ -606,6 +606,19 @@ error. @code{libgamma_value_of_error} will return zero
if the input is @code{NULL} or string that is not the
name of a @command{libgamma} error.
+The function @code{libgamma_perror} can be used to
+print an error to stderr in a @code{perror} fashion.
+However @code{libgamma_perror} will not translate the
+@command{libgamma} errors into human-readable strings,
+it will simply print the name of the error.
+@code{libgamma_perror} takes two arguments:
+a @code{const char*} that work like the parameter for
+@code{perror}, and an @code{int} with the error code.
+If the error code is the value of @code{LIBGAMMA_ERRNO_SET}
+@code{perror} will be used to print the current error
+stored in @code{errno}. If the error code is non-negative
+(an @code{errno} value`), that value will be stored in
+@code{errno} and @code{perror} will be used to print it.
@node GNU Free Documentation License