From 40343b5f4aff6b0c208288d695f04f80f2321f1c Mon Sep 17 00:00:00 2001 From: Marcus Brinkmann Date: Tue, 29 Jul 2003 18:25:27 +0000 Subject: [PATCH] 2003-07-29 Marcus Brinkmann * gpgme.texi (Encrypting a Plaintext): Mention encrypt and sign operations in result function. (Creating a Signature): Likewise. --- doc/ChangeLog | 6 ++++++ doc/gpgme.texi | 28 ++++++++++++++++------------ 2 files changed, 22 insertions(+), 12 deletions(-) diff --git a/doc/ChangeLog b/doc/ChangeLog index 9b5a1da3..4b41c57b 100644 --- a/doc/ChangeLog +++ b/doc/ChangeLog @@ -1,3 +1,9 @@ +2003-07-29 Marcus Brinkmann + + * gpgme.texi (Encrypting a Plaintext): Mention encrypt and sign + operations in result function. + (Creating a Signature): Likewise. + 2003-07-23 Marcus Brinkmann * gpgme.texi (Key Listing Mode): Remove word duplication. diff --git a/doc/gpgme.texi b/doc/gpgme.texi index 1f518dbc..caf622d6 100644 --- a/doc/gpgme.texi +++ b/doc/gpgme.texi @@ -3957,12 +3957,14 @@ A linked list with information about all signatures created. @deftypefun gpgme_sign_result_t gpgme_op_sign_result (@w{gpgme_ctx_t @var{ctx}}) The function @code{gpgme_op_sign_result} returns a -@code{gpgme_sign_result_t} pointer to a structure holding the result of a -@code{gpgme_op_sign} operation. The pointer is only valid if the last -operation on the context was a @code{gpgme_op_sign} or -@code{gpgme_op_sign_start} operation, and if this operation finished -successfully. The returned pointer is only valid until the next -operation is started on the context. +@code{gpgme_sign_result_t} pointer to a structure holding the result +of a @code{gpgme_op_sign} operation. The pointer is only valid if the +last operation on the context was a @code{gpgme_op_sign}, +@code{gpgme_op_sign_start}, @code{gpgme_op_encrypt_sign} or +@code{gpgme_op_encrypt_sign_start} operation. If that operation +failed, the function might return a @code{NULL} pointer, The returned +pointer is only valid until the next operation is started on the +context. @end deftypefun @@ -4061,12 +4063,14 @@ the data could not be encrypted. @deftypefun gpgme_encrypt_result_t gpgme_op_encrypt_result (@w{gpgme_ctx_t @var{ctx}}) The function @code{gpgme_op_encrypt_result} returns a -@code{gpgme_encrypt_result_t} pointer to a structure holding the result of -a @code{gpgme_op_encrypt} operation. The pointer is only valid if the -last operation on the context was a @code{gpgme_op_encrypt} or -@code{gpgme_op_encrypt_start} operation, and if this operation -finished successfully. The returned pointer is only valid until the -next operation is started on the context. +@code{gpgme_encrypt_result_t} pointer to a structure holding the +result of a @code{gpgme_op_encrypt} operation. The pointer is only +valid if the last operation on the context was a +@code{gpgme_op_encrypt}, @code{gpgme_op_encrypt_start}, +@code{gpgme_op_sign} or @code{gpgme_op_sign_start} operation. If this +operation failed, this might be a @code{NULL} pointer. The returned +pointer is only valid until the next operation is started on the +context. @end deftypefun