aboutsummaryrefslogtreecommitdiffstats
path: root/doc
diff options
context:
space:
mode:
authorMarcus Brinkmann <[email protected]>2002-02-26 23:39:58 +0000
committerMarcus Brinkmann <[email protected]>2002-02-26 23:39:58 +0000
commit31b2a458ff66a70fffe587448d60044b7127b795 (patch)
tree4b878c81bd811c278f354beb093aa4651262375b /doc
parent2002-02-27 Marcus Brinkmann <[email protected]> (diff)
downloadgpgme-31b2a458ff66a70fffe587448d60044b7127b795.tar.gz
gpgme-31b2a458ff66a70fffe587448d60044b7127b795.zip
doc/
2002-02-27 Marcus Brinkmann <[email protected]> * gpgme.texi (Encrypting a Plaintext): Document GPGME_Invalid_Recipients. (Error Values): Likewise. gpgme/ 2002-02-27 Marcus Brinkmann <[email protected]> * gpgme.h: Add new error code GPGME_Invalid_Recipient. * encrypt.c (struct encrypt_result_s): New member invalid_recipients, rename no_recipients to no_valid_recipients. (_gpgme_encrypt_status_handler): Include error for invalid recipients. * engine-gpgsm.c (gpgsm_set_recipients): Change type of first argument to GpgsmObject. Use that to report back the status about the recipients.
Diffstat (limited to 'doc')
-rw-r--r--doc/ChangeLog6
-rw-r--r--doc/gpgme.texi24
2 files changed, 22 insertions, 8 deletions
diff --git a/doc/ChangeLog b/doc/ChangeLog
index fe5eb4e5..8ae8ae2b 100644
--- a/doc/ChangeLog
+++ b/doc/ChangeLog
@@ -1,3 +1,9 @@
+2002-02-27 Marcus Brinkmann <[email protected]>
+
+ * gpgme.texi (Encrypting a Plaintext): Document
+ GPGME_Invalid_Recipients.
+ (Error Values): Likewise.
+
2002-02-26 Marcus Brinkmann <[email protected]>
* gpgme.texi (Encrypting a Plaintext): Document
diff --git a/doc/gpgme.texi b/doc/gpgme.texi
index 2be6170b..5c2a084d 100644
--- a/doc/gpgme.texi
+++ b/doc/gpgme.texi
@@ -615,7 +615,11 @@ This value means that there are too many active backend processes.
This value means that the creation of a pipe failed.
@item GPGME_No_Recipients
-This value means that no recipients for a message have been set.
+This value means that no valid recipients for a message have been set.
+
+@item GPGME_Invalid_Recipients
+This value means that some, but not all, recipients for a message have
+been invalid.
@item GPGME_No_Data
This value means that a @code{GpgmeData} object which was expected to
@@ -2207,16 +2211,20 @@ ciphertext in the data object @var{cipher}. The type of the
ciphertext created is determined by the @acronym{ASCII} armor and text
mode attributes set for the context @var{ctx}.
-More information about the encrypted text is available with
+If @code{GPGME_Invalid_Recipients} is returned, some recipients in
+@var{rset} are invalid, but not all. In this case the plaintext is
+encrypted for all valid recipients and returned in @var{cipher}. More
+information about the invalid recipients is available with
@code{gpgme_get_op_info}. @xref{Detailed Results}.
The function returns @code{GPGME_No_Error} if the ciphertext could be
created successfully, @code{GPGME_Invalid_Value} if @var{ctx},
@var{rset}, @var{plain} or @var{cipher} is not a valid pointer,
-@code{GPGME_No_Recipient} if @var{rset} does not contain any
-valid recipients, @code{GPGME_No_Passphrase} if the passphrase for the
-secret key could not be retrieved, and passes through any errors that
-are reported by the crypto engine support routines.
+@code{GPGME_No_Recipients} if @var{rset} does not contain any valid
+recipients, @code{GPGME_Invalid_Recipients} if @var{rset} contains
+some invalid recipients, @code{GPGME_No_Passphrase} if the passphrase
+for the secret key could not be retrieved, and passes through any
+errors that are reported by the crypto engine support routines.
@end deftypefun
@deftypefun GpgmeError gpgme_op_encrypt_start (@w{GpgmeCtx @var{ctx}}, @w{GpgmeRecipients @var{rset}}, @w{GpgmeData @var{plain}}, @w{GpgmeData @var{cipher}})
@@ -2227,7 +2235,7 @@ The function @code{gpgme_op_encrypt_start} initiates a
The function returns @code{GPGME_No_Error} if the operation could be
started successfully, @code{GPGME_Invalid_Value} if @var{ctx},
@var{rset}, @var{plain} or @var{cipher} is not a valid pointer, and
-@code{GPGME_No_Recipient} if @var{rset} does not contain any valid
+@code{GPGME_No_Recipients} if @var{rset} does not contain any valid
recipients.
@end deftypefun
@@ -2251,7 +2259,7 @@ Completion}.
The function returns @code{GPGME_No_Error} if the operation could be
started successfully, @code{GPGME_Invalid_Value} if @var{ctx},
@var{rset}, @var{plain} or @var{cipher} is not a valid pointer, and
-@code{GPGME_No_Recipient} if @var{rset} does not contain any valid
+@code{GPGME_No_Recipients} if @var{rset} does not contain any valid
recipients.
@end deftypefun