From 174e293252a29ae7c44198cf6fc2ee8dd67ec721 Mon Sep 17 00:00:00 2001 From: Marcus Brinkmann Date: Mon, 28 Apr 2003 21:17:15 +0000 Subject: doc/ 2003-04-28 Marcus Brinkmann * gpgme.texi (Decrypt): Descript gpgme_op_decrypt_result and GpgmeDecryptResult. gpgme 2003-04-28 Marcus Brinkmann * gpgme.h (struct _gpgme_op_decrypt_result): New structure. (GpgmeDecryptResult): New type. (gpgme_op_decrypt_result): New prototype. * ops.h (_gpgme_op_decrypt_init_result): New prototype. (_gpgme_decrypt_status_handler): Fix prototype. (_gpgme_decrypt_start): Remove prototype. * decrypt-verify.c: Do not include , , and , "util.h" and "context.h", but "gpgme.h". (decrypt_verify_status_handler): Change first argument to void *, and rework error handling. (_gpgme_op_decrypt_verify_start): New function. (gpgme_op_decrypt_verify_start): Rewrite using _gpgme_op_decrypt_verify_start. (gpgme_op_decrypt_verify): Likewise. * decrypt.c: Include , "gpgme.h" and "util.h". (struct decrypt_result): Change to typedef op_data_t, rewritten. (is_token): Remove function. (release_op_data): New function. (skip_token): Remove function. (gpgme_op_decrypt_result): New function. (_gpgme_decrypt_status_handler): Change first argument to void *. Rework error handling. (_gpgme_decrypt_start): Rename to ... (decrypt_start): ... this. Call _gpgme_op_decrypt_init_result. (_gpgme_op_decrypt_init_result): New function. (gpgme_op_decrypt_start): Use decrypt_start. (gpgme_op_decrypt): Likewise. tests/ 2003-04-28 Marcus Brinkmann * gpg/t-decrypt.c: Rewritten. --- doc/ChangeLog | 5 +++++ doc/gpgme.texi | 24 ++++++++++++++++++++++++ 2 files changed, 29 insertions(+) (limited to 'doc') diff --git a/doc/ChangeLog b/doc/ChangeLog index 00055c80..778625e4 100644 --- a/doc/ChangeLog +++ b/doc/ChangeLog @@ -1,3 +1,8 @@ +2003-04-28 Marcus Brinkmann + + * gpgme.texi (Decrypt): Descript gpgme_op_decrypt_result and + GpgmeDecryptResult. + 2003-04-27 Marcus Brinkmann * gpgme.texi (Encrypting a Plaintext): Add info about diff --git a/doc/gpgme.texi b/doc/gpgme.texi index 137e9670..4e15fa07 100644 --- a/doc/gpgme.texi +++ b/doc/gpgme.texi @@ -2774,6 +2774,30 @@ started successfully, and @code{GPGME_Invalid_Value} if @var{cipher} or @var{plain} is not a valid pointer. @end deftypefun +@deftp {Data type} {GpgmeDecryptResult} +This is a pointer to a structure used to store the result of a +@code{gpgme_op_decrypt} operation. After successfully encrypting +data, you can retrieve the pointer to the result with +@code{gpgme_op_decrypt_result}. The structure contains the following +members: + +@table @code +@item char *unsupported_algorithm +If an unsupported algorithm was encountered, this string describes the +algorithm that is not supported. +@end table +@end deftp + +@deftypefun GpgmeDecryptResult gpgme_op_decrypt_result (@w{GpgmeCtx @var{ctx}}) +The function @code{gpgme_op_decrypt_result} returns a +@code{GpgmeDecryptResult} pointer to a structure holding the result of +a @code{gpgme_op_decrypt} operation. The pointer is only valid if the +last operation on the context was a @code{gpgme_op_decrypt} or +@code{gpgme_op_decrypt_start} operation, and if this operation +finished successfully. The returned pointer is only valid until the +next operation is started on the context. +@end deftypefun + @node Verify @subsection Verify -- cgit v1.2.3