From a336bc6834099b62b17c6e772763328145537dc2 Mon Sep 17 00:00:00 2001 From: Marcus Brinkmann Date: Thu, 6 Oct 2005 10:44:26 +0000 Subject: doc/ 2005-10-06 Marcus Brinkmann * gpgme.texi (Destroying Data Buffers): Document gpgme_free. gpgme/ 2005-10-06 Marcus Brinkmann * gpgme.h (gpgme_free): New prototype. * data-mem.c (gpgme_free): New function. * libgpgme.vers (GPGME_1.1): Add gpgme_free. * gpgme.def: Add gpgme_free. --- doc/ChangeLog | 4 ++++ doc/gpgme.texi | 14 +++++++++++--- 2 files changed, 15 insertions(+), 3 deletions(-) (limited to 'doc') diff --git a/doc/ChangeLog b/doc/ChangeLog index 1afd92d9..acc5adae 100644 --- a/doc/ChangeLog +++ b/doc/ChangeLog @@ -1,3 +1,7 @@ +2005-10-06 Marcus Brinkmann + + * gpgme.texi (Destroying Data Buffers): Document gpgme_free. + 2005-10-02 Marcus Brinkmann * gpgme.texi (Key Management): Add the new member notations of diff --git a/doc/gpgme.texi b/doc/gpgme.texi index a44cc60f..fc3a0f38 100644 --- a/doc/gpgme.texi +++ b/doc/gpgme.texi @@ -1711,15 +1711,23 @@ The function @code{gpgme_data_release_and_get_mem} is like @code{gpgme_data_release}, except that it returns the data buffer and its length that was provided by the object. -The user has to release the buffer with @code{free}. In case the user -provided the data buffer in non-copy mode, a copy will be made for -this purpose. +The user has to release the buffer with @code{gpgme_free}. In case +the user provided the data buffer in non-copy mode, a copy will be +made for this purpose. In case an error returns, or there is no suitable data buffer that can be returned to the user, the function will return @code{NULL}. @end deftypefun +@deftypefun void gpgme_free (@w{void *@var{buffer}}) +The function @code{gpgme_free} releases the memory returned by +@code{gpgme_data_release_and_get_mem}. It should be used instead of +the system libraries @code{free} function in case different allocators +are used in a single program. +@end deftypefun + + @node Manipulating Data Buffers @section Manipulating Data Buffers @cindex data buffer, manipulation -- cgit v1.2.3