aboutsummaryrefslogtreecommitdiffstats
path: root/doc/gpgme.texi
diff options
context:
space:
mode:
authorMarcus Brinkmann <[email protected]>2002-02-06 01:20:49 +0000
committerMarcus Brinkmann <[email protected]>2002-02-06 01:20:49 +0000
commit69ab559a7b7ea9f05b68911d17bb33b7f85c033c (patch)
treef66d40de6adc897fdf19459c3ea0baebe5974e7d /doc/gpgme.texi
parentdoc/ (diff)
downloadgpgme-69ab559a7b7ea9f05b68911d17bb33b7f85c033c.tar.gz
gpgme-69ab559a7b7ea9f05b68911d17bb33b7f85c033c.zip
doc/
2002-02-06 Marcus Brinkmann <[email protected]> * gpgme.texi (Waiting For Completion): Adjust doc to changes in the code. gpgme/ 2002-02-06 Marcus Brinkmann <[email protected]> * wait.c (gpgme_wait): Add new argument STATUS, in which the status of the returned context is returned. (_gpgme_wait_on_condition): Rework the function a bit, to make it aware of cancelled processes, and to allow to use gpgme_wait with CTX being NULL (as documented in the source). (struct proc_s): New member REPORTED. * gpgme.h: Fix prototype. * verify.c (gpgme_op_verify): Fix use of gpgme_wait. * sign.c (gpgme_op_sign): * import.c (gpgme_op_import): * genkey.c (gpgme_op_genkey): * export.c (gpgme_op_export): * encrypt.c (gpgme_op_encrypt): * delete.c (gpgme_op_delete): * decrypt-verify.c (gpgme_op_decrypt_verify):
Diffstat (limited to '')
-rw-r--r--doc/gpgme.texi13
1 files changed, 10 insertions, 3 deletions
diff --git a/doc/gpgme.texi b/doc/gpgme.texi
index e2f68ef8..2b4cf5a0 100644
--- a/doc/gpgme.texi
+++ b/doc/gpgme.texi
@@ -1337,7 +1337,7 @@ This is the type of a trust item.
@item GPGME_ATTR_IS_SECRET
This specifies if the key is a secret key. It is representable as a
string or a number. If the key is a secret key, the representation is
-``1'' or @code{1}, otherwise it is NULL or @code{0}.
+``1'' or @code{1}, otherwise it is @code{NULL} or @code{0}.
@item GPGME_ATTR_KEY_REVOKED
This specifies if a sub key is revoked. It is representable as a
@@ -2233,7 +2233,7 @@ later point.
@cindex cryptographic operation, wait for
@cindex wait for completion
-@deftypefun GpgmeCtx gpgme_wait (@w{GpgmeCtx @var{ctx}}, @w{int @var{hang}})
+@deftypefun GpgmeCtx gpgme_wait (@w{GpgmeCtx @var{ctx}}, @w{GpgmeError *@var{status}}, @w{int @var{hang}})
The function @code{gpgme_wait} does continue the pending operation
within the context @var{ctx}. In particular, it ensures the data
exchange between @acronym{GPGME} and the crypto backend and watches
@@ -2243,7 +2243,14 @@ If @var{hang} is true, the function does not return until the
operation is completed or cancelled. Otherwise the function will not
block for a long time.
-The function returns @var{ctx}.
+The error status of the finished operation is returned in
+@var{status}.
+
+The @var{ctx} argument can be @code{NULL}. In that case,
+@code{gpgme_wait} waits for any context to complete its operation.
+
+The function returns the @var{ctx} of the context which has finished
+the operation.
@end deftypefun