From 1a528ebd75409cef833385b9b50d0449f668d093 Mon Sep 17 00:00:00 2001 From: Mattias Andrée Date: Sat, 31 May 2014 06:05:40 +0200 Subject: info: doc libgamma_name_of_error and libgamma_value_of_error MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Signed-off-by: Mattias Andrée --- info/libgamma.texinfo | 13 +++++++++++++ 1 file changed, 13 insertions(+) (limited to 'info') 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 -- cgit v1.2.3-70-g09d2