diff options
author | Werner Koch <wk@gnupg.org> | 2008-10-20 15:24:01 +0000 |
---|---|---|
committer | Werner Koch <wk@gnupg.org> | 2008-10-20 15:24:01 +0000 |
commit | 467211879b93495e4c423c057fffe78e7b18089f (patch) | |
tree | 16ab8024e028f07f2a7d9dd34b7b436a3a2f24e8 /doc | |
parent | 71462e1c49dbe9771da8951619234299b923e1f0 (diff) | |
download | libgcrypt-467211879b93495e4c423c057fffe78e7b18089f.tar.gz |
doc fix.
Diffstat (limited to 'doc')
-rw-r--r-- | doc/ChangeLog | 6 | ||||
-rw-r--r-- | doc/gcrypt.texi | 10 |
2 files changed, 14 insertions, 2 deletions
diff --git a/doc/ChangeLog b/doc/ChangeLog index b619baa6..da766871 100644 --- a/doc/ChangeLog +++ b/doc/ChangeLog @@ -1,3 +1,9 @@ +2008-10-20 Werner Koch <wk@g10code.com> + + * gcrypt.texi (Error handler): Fix description of + gcry_handler_no_mem_t. Reported by Patrick Strateman. desribe + what what the error handler is expected to do. Fixes bug #961. + 2008-09-18 Werner Koch <wk@g10code.com> * gcrypt.texi (FIPS Mode): Add state transition Error to Error. diff --git a/doc/gcrypt.texi b/doc/gcrypt.texi index a1bb696b..32f21171 100644 --- a/doc/gcrypt.texi +++ b/doc/gcrypt.texi @@ -1320,12 +1320,18 @@ are called by Libgcrypt in case certain error conditions occur. They may and should be registered prior to calling @code{gcry_check_version}. @deftp {Data type} gcry_handler_no_mem_t -This type is defined as: @code{void (*gcry_handler_no_mem_t) (void *, size_t, unsigned int)} +This type is defined as: @code{int (*gcry_handler_no_mem_t) (void *, size_t, unsigned int)} @end deftp @deftypefun void gcry_set_outofcore_handler (gcry_handler_no_mem_t @var{func_no_mem}, void *@var{cb_data}) This function registers @var{func_no_mem} as `out-of-core handler', which means that it will be called in the case of not having enough -memory available. +memory available. The handler is called with 3 arguments: The first +one is the pointer @var{cb_data} as set with this function, the second +is the requested memory size and the last being a flag. If bit 0 of +the flag is set, secure memory has been requested. The handler should +either return true to indicate that Libgcrypt should try again +allocating memory or return false to let Libgcrypt use its default +fatal error handler. @end deftypefun @deftp {Data type} gcry_handler_error_t |