aboutsummaryrefslogtreecommitdiffstats
path: root/doc
diff options
context:
space:
mode:
authorMarcus Brinkmann <[email protected]>2003-04-27 22:24:37 +0000
committerMarcus Brinkmann <[email protected]>2003-04-27 22:24:37 +0000
commit588c16d324e83e64ccdc8761e3fb3b91648528fc (patch)
tree6778d9067f57dae58335abc356119b2b47b23e4f /doc
parentdoc/ (diff)
downloadgpgme-588c16d324e83e64ccdc8761e3fb3b91648528fc.tar.gz
gpgme-588c16d324e83e64ccdc8761e3fb3b91648528fc.zip
doc/
2003-04-27 Marcus Brinkmann <[email protected]> * gpgme.texi (Encrypting a Plaintext): Add info about GpgmeEncryptResult and gpgme_op_encrypt_result. gpgme/ 2003-04-27 Marcus Brinkmann <[email protected]> * gpgme.h (GpgmeEncryptResult): New data type. (gpgme_op_encrypt_result): New prototype. * ops.h (_gpgme_op_encrypt_init_result): New prototype. (_gpgme_op_encrypt_status_handler): Fix prototype. * encrypt-sign.c (_gpgme_op_encrypt_sign_start): Call _gpgme_op_encrypt_init_result. * encrypt.c: Do not include <stdio.h>, <assert.h>, "util.h" and "wait.h". Include <errno.h> and "gpgme.h". (SKIP_TOKEN_OR_RETURN): Remove macro. (struct encrypt_result): Rename to ... (op_data_t): ... new data type. Rewrite for user result data. (append_xml_encinfo): Remove function. (release_op_data): New function. (gpgme_op_encrypt_result): New function. (_gpgme_op_encrypt_status_handler): Change first argument to void *. Rewrite result parsing. (_gpgme_op_encrypt_sym_status_handler): Change first argument to void *. (_gpgme_op_encrypt_init_result): New function. (_gpgme_op_encrypt_start): Rename to ... (encrypt_start): ... this. (gpgme_op_encrypt_start): Use encrypt_start, not gpgme_op_encrypt_start. (gpgme_op_encrypt): Likewise. tests/ 2003-04-27 Marcus Brinkmann <[email protected]> * gpg/t-sign.c: Rewritten. * gpgsm/t-sign.c: Rewritten. * gpg/t-encrypt.c: Check for invalid recipients. * gpgsm/t-encrypt.c: Likewise.
Diffstat (limited to 'doc')
-rw-r--r--doc/ChangeLog3
-rw-r--r--doc/gpgme.texi24
2 files changed, 27 insertions, 0 deletions
diff --git a/doc/ChangeLog b/doc/ChangeLog
index 0edda75b..00055c80 100644
--- a/doc/ChangeLog
+++ b/doc/ChangeLog
@@ -1,5 +1,8 @@
2003-04-27 Marcus Brinkmann <[email protected]>
+ * gpgme.texi (Encrypting a Plaintext): Add info about
+ GpgmeEncryptResult and gpgme_op_encrypt_result.
+
* gpgme.texi (Creating a Signature): Add info about
GpgmeNewSignature, GpgmeSignResult and gpgme_op_sign_result.
(Crypto Operations): Add GpgmeInvalidUserID.
diff --git a/doc/gpgme.texi b/doc/gpgme.texi
index e1c8c856..137e9670 100644
--- a/doc/gpgme.texi
+++ b/doc/gpgme.texi
@@ -3357,6 +3357,30 @@ started successfully, @code{GPGME_Invalid_Value} if @var{ctx},
recipients.
@end deftypefun
+@deftp {Data type} {GpgmeEncryptResult}
+This is a pointer to a structure used to store the result of a
+@code{gpgme_op_encrypt} operation. After successfully encrypting
+data, you can retrieve the pointer to the result with
+@code{gpgme_op_encrypt_result}. The structure contains the following
+members:
+
+@table @code
+@item GpgmeInvalidUserID invalid_recipients
+A linked list with information about all invalid user IDs for which
+the data could not be encrypted.
+@end table
+@end deftp
+
+@deftypefun GpgmeEncryptResult gpgme_op_encrypt_result (@w{GpgmeCtx @var{ctx}})
+The function @code{gpgme_op_encrypt_result} returns a
+@code{GpgmeEncryptResult} 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.
+@end deftypefun
+
@deftypefun GpgmeError gpgme_op_encrypt_sign (@w{GpgmeCtx @var{ctx}}, @w{GpgmeRecipients @var{rset}}, @w{GpgmeData @var{plain}}, @w{GpgmeData @var{cipher}})
The function @code{gpgme_op_encrypt_sign} does a combined encrypt and