GpgFrontend/gpgme
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

2007-05-18 Marcus Brinkmann <marcus@g10code.de>

Browse Source 
* gpgme.texi (Error Strings): Fix documentation of
	gpgme_strerror_r.
This commit is contained in:
Marcus Brinkmann 2007-05-18 22:30:42 +00:00
parent f2bd9ab3be
commit 2c5d7a18a9
2 changed files with 15 additions and 8 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
doc/ChangeLog
View File

@ -1,3 +1,7 @@
2007-05-18 Marcus Brinkmann <marcus@g10code.de>
* gpgme.texi (Error Strings): Fix documentation of
gpgme_strerror_r.
2006-11-01 Moritz Schulte <moritz@g10code.com>

19
doc/gpgme.texi
View File

@ -21,7 +21,7 @@ This is Edition @value{EDITION}, last updated @value{UPDATED}, of
@value{VERSION}.
@c NOTE: Don't forget to update the year for the TeX version, too.
Copyright @copyright{} 2002, 2003, 2004, 2005 g10 Code GmbH.
Copyright @copyright{} 2002, 2003, 2004, 2005, 2006, 2007 g10 Code GmbH.
The GPGME reference manual is free software; you can redistribute it
and/or modify it under the terms of the GNU Lesser General Public
@ -54,7 +54,7 @@ Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA
@center for version @value{VERSION}
@page
@vskip 0pt plus 1filll
Copyright @copyright{} 2002, 2003, 2004, 2005 g10 Code GmbH.
Copyright @copyright{} 2002, 2003, 2004, 2005, 2006, 2007 g10 Code GmbH.
The GPGME reference manual is free software; you can redistribute it
@ -1403,12 +1403,15 @@ 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}.
@deftypefun {int} gpgme_strerror_r (@w{gpgme_error_t @var{err}}, @w{char *@var{buf}}, @w{size_t @var{buflen}})
The function @code{gpgme_strerror_r} returns the error string for
@var{err} in the user-supplied buffer @var{buf} of size @var{buflen}.
This function is, in contrast to @code{gpgme_strerror}, thread-safe if
a thread-safe @code{strerror_r} function is provided by the system.
If the function succeeds, 0 is returned and @var{buf} contains the
string describing the error. If the buffer was not large enough,
ERANGE is returned and @var{buf} contains as much of the beginning of
the error string as fits into the buffer.
@end deftypefun