2002-11-21 Marcus Brinkmann <marcus@g10code.de>

* gpgme.texi (Verify): Document the new interface.
This commit is contained in:
Marcus Brinkmann 2002-11-21 13:45:00 +00:00
parent b1456f1c19
commit 8f0283d81a
2 changed files with 14 additions and 9 deletions

View File

@ -1,3 +1,7 @@
2002-11-21 Marcus Brinkmann <marcus@g10code.de>
* gpgme.texi (Verify): Document the new interface.
2002-11-19 Marcus Brinkmann <marcus@g10code.de> 2002-11-19 Marcus Brinkmann <marcus@g10code.de>
* gpgme.texi (Generating Keys): Document new argument to * gpgme.texi (Generating Keys): Document new argument to

View File

@ -2198,15 +2198,16 @@ have a different status. You can get each key's status with
@end table @end table
@end deftp @end deftp
@deftypefun GpgmeError gpgme_op_verify (@w{GpgmeCtx @var{ctx}}, @w{GpgmeData @var{sig}}, @w{GpgmeData @var{plain}}, @w{GpgmeSigStat *@var{r_stat}})
@deftypefun GpgmeError gpgme_op_verify (@w{GpgmeCtx @var{ctx}}, @w{GpgmeData @var{sig}}, @w{GpgmeData @var{signed_text}}, @w{GpgmeData @var{plain}}, @w{GpgmeSigStat *@var{r_stat}})
The function @code{gpgme_op_verify} verifies that the signature in the The function @code{gpgme_op_verify} verifies that the signature in the
data object @var{sig} is a valid signature. If @var{plain} is data object @var{sig} is a valid signature. If @var{sig} is a
initialized with plaintext data, it is assumed that @var{sig} is a detached signature, then the signed text should be provided in
detached signature, and its validity for the plaintext given in @var{signed_text} and @var{plain} should be a null pointer.
@var{plain} is verified. If @var{plain} is an uninitialized data Otherwise, if @var{sig} is a normal (or cleartext) signature,
object, it is assumed that @var{sig} is a normal (or cleartext) @var{signed_text} should be a null pointer and @var{plain} should be a
signature, and the plaintext is available in @var{plain} after writable data object that will contain the plaintext after successful
successful verification. verification.
The combined status of all signatures is returned in @var{r_stat}. The combined status of all signatures is returned in @var{r_stat}.
The results of the individual signature verifications can be retrieved The results of the individual signature verifications can be retrieved
@ -2220,7 +2221,7 @@ and passes through any errors that are reported by the crypto engine
support routines. support routines.
@end deftypefun @end deftypefun
@deftypefun GpgmeError gpgme_op_verify_start (@w{GpgmeCtx @var{ctx}}, @w{GpgmeData @var{sig}}, @w{GpgmeData @var{plain}}) @deftypefun GpgmeError gpgme_op_verify_start (@w{GpgmeCtx @var{ctx}}, @w{GpgmeData @var{sig}}, @w{GpgmeData @var{signed_text}}, @w{GpgmeData @var{plain}})
The function @code{gpgme_op_verify_start} initiates a The function @code{gpgme_op_verify_start} initiates a
@code{gpgme_op_verify} operation. It can be completed by calling @code{gpgme_op_verify} operation. It can be completed by calling
@code{gpgme_wait} on the context. @xref{Waiting For Completion}. @code{gpgme_wait} on the context. @xref{Waiting For Completion}.