aboutsummaryrefslogtreecommitdiffstats
path: root/doc
diff options
context:
space:
mode:
authorMarcus Brinkmann <[email protected]>2003-09-13 21:45:13 +0000
committerMarcus Brinkmann <[email protected]>2003-09-13 21:45:13 +0000
commitc4ea1235d56f7ab89ff84fef894d9c0d378d8b72 (patch)
tree91d59a0c11c60c0ab1ca8fa15acbd4d3f69244dd /doc
parent2003-09-13 Marcus Brinkmann <[email protected]> (diff)
downloadgpgme-c4ea1235d56f7ab89ff84fef894d9c0d378d8b72.tar.gz
gpgme-c4ea1235d56f7ab89ff84fef894d9c0d378d8b72.zip
doc/
2003-09-13 Marcus Brinkmann <[email protected]> * gpgme.texi (Error Strings): Add gpgme_strerror_r. gpgme/ 2003-09-13 Marcus Brinkmann <[email protected]> * gpgme.h (gpgme_strerror_r): New prototype. * error.c (gpgme_strerror_r): New function.
Diffstat (limited to '')
-rw-r--r--doc/ChangeLog4
-rw-r--r--doc/gpgme.texi12
2 files changed, 16 insertions, 0 deletions
diff --git a/doc/ChangeLog b/doc/ChangeLog
index 16586ed4..dd2c2f02 100644
--- a/doc/ChangeLog
+++ b/doc/ChangeLog
@@ -1,5 +1,9 @@
2003-09-13 Marcus Brinkmann <[email protected]>
+ * gpgme.texi (Error Strings): Add gpgme_strerror_r.
+
+2003-09-13 Marcus Brinkmann <[email protected]>
+
* gpgme.texi (Multi Threading): Update documentation.
2003-09-03 Marcus Brinkmann <[email protected]>
diff --git a/doc/gpgme.texi b/doc/gpgme.texi
index 30837f9a..1e00d752 100644
--- a/doc/gpgme.texi
+++ b/doc/gpgme.texi
@@ -1232,6 +1232,18 @@ The function @code{gpgme_strerror} returns a pointer to a statically
allocated string containing a description of the error code contained
in the error value @var{err}. This string can be used to output a
diagnostic message to the user.
+
+This function is not thread safe. Use @code{gpgme_strerror_r} in
+multi-threaded programs.
+@end deftypefun
+
+
+@deftypefun {char *} gpgme_strerror_r (@w{gpgme_error_t @var{err}})
+The function @code{gpgme_strerror_r} returns a pointer to a
+dynamically allocated string containing a description of the error
+code contained in the error value @var{err}. This string can be used
+to output a diagnostic message to the user. When it is not needed
+anymore, the user must deallocate it with @code{free}.
@end deftypefun