aboutsummaryrefslogtreecommitdiffstats
path: root/info
diff options
context:
space:
mode:
authorMattias Andrée <maandree@operamail.com>2014-05-31 06:05:40 +0200
committerMattias Andrée <maandree@operamail.com>2014-05-31 06:05:40 +0200
commit1a528ebd75409cef833385b9b50d0449f668d093 (patch)
tree67fdd671bae644e13e3ee79ae402990148907816 /info
parentadd libgamma_name_of_error and libgamma_value_of_error (diff)
downloadlibgamma-1a528ebd75409cef833385b9b50d0449f668d093.tar.gz
libgamma-1a528ebd75409cef833385b9b50d0449f668d093.tar.bz2
libgamma-1a528ebd75409cef833385b9b50d0449f668d093.tar.xz
info: doc libgamma_name_of_error and libgamma_value_of_error
Signed-off-by: Mattias Andrée <maandree@operamail.com>
Diffstat (limited to 'info')
-rw-r--r--info/libgamma.texinfo13
1 files changed, 13 insertions, 0 deletions
diff --git a/info/libgamma.texinfo b/info/libgamma.texinfo
index 8bac4b8..78643ee 100644
--- a/info/libgamma.texinfo
+++ b/info/libgamma.texinfo
@@ -593,6 +593,19 @@ that its functions may return:
£>done
@end table
+The function @code{libgamma_name_of_error} can
+be used to return the name of an libgamma error.
+For example @code{libgamma_name_of_error(LIBGAMMA_ERRNO_SET)}
+will return the string ``LIBGAMMA_ERRNO_SET''.
+Similarly @code{libgamma_value_of_error("LIBGAMMA_ERRNO_SET")}
+will return the value of @code{LIBGAMMA_ERRNO_SET}.
+The value returned from @code{libgamma_name_of_error}
+shall not be @code{free}:d. @code{NULL} is returned
+if the value does nto refer to a @command{libgamma}
+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.
+
@node GNU Free Documentation License